Public Member Functions | List of all members
aspect::BoundaryVelocity::Interface< dim > Class Template Referenceabstract
Inheritance diagram for aspect::BoundaryVelocity::Interface< dim >:
Inheritance graph

Public Member Functions

virtual Tensor< 1, dim > boundary_velocity (const types::boundary_id boundary_indicator, const Point< dim > &position) const =0
- Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual ~InterfaceBase ()=default
virtual void initialize ()
virtual void update ()
virtual void parse_parameters (ParameterHandler &prm)

Additional Inherited Members

- Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void declare_parameters (ParameterHandler &prm)

Detailed Description

template<int dim>
class aspect::BoundaryVelocity::Interface< dim >

A base class for parameterizations of velocity boundary conditions.

Definition at line 100 of file simulator_access.h.

Member Function Documentation

§ boundary_velocity()

template<int dim>
virtual Tensor<1,dim> aspect::BoundaryVelocity::Interface< dim >::boundary_velocity ( const types::boundary_id  boundary_indicator,
const Point< dim > &  position 
) const
pure virtual

Return the velocity that is to hold at a particular position on the boundary of the domain.

boundary_indicatorThe boundary indicator of the part of the boundary of the domain on which the point is located at which we are requesting the velocity.
positionThe position of the point at which we ask for the velocity.
Boundary velocity at position position.

Implemented in aspect::BoundaryVelocity::GPlates< dim >, aspect::BoundaryVelocity::AsciiData< dim >, aspect::BoundaryVelocity::Function< dim >, and aspect::BoundaryVelocity::ZeroVelocity< dim >.

The documentation for this class was generated from the following files: