surface.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_SURFACE_H
#define LIBMESH_SURFACE_H

// Local includes
#include "libmesh/point.h"

namespace libMesh
{

class Surface
{
public:

  Surface () = default;

  Surface (const Surface &) = default;

  virtual ~Surface () = default;

  virtual bool above_surface (const Point & p) const = 0;

  virtual bool below_surface (const Point & p) const = 0;

  virtual bool on_surface (const Point & p) const = 0;

  virtual Point closest_point (const Point & p) const = 0;

  virtual Point unit_normal (const Point & p) const = 0;

  virtual Point surface_coords (const Point & world_coords) const { return world_coords; }

  virtual Point world_coords (const Point & surf_coords) const { return surf_coords; }
};

} // namespace libMesh

#endif // LIBMESH_SURFACE_H