aspect::PrescribedStokesSolution::Interface< dim > Class Template Reference

Inheritance diagram for aspect::PrescribedStokesSolution::Interface< dim >:

Public Member Functions
virtual	~Interface ()=default
virtual void	initialize ()
virtual void	update ()
virtual void	stokes_solution (const Point< dim > &p, Vector< double > &value) const =0
virtual void	parse_parameters (ParameterHandler &prm)

Static Public Member Functions
static void	declare_parameters (ParameterHandler &prm)

Detailed Description

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

This plugin allows the user to prescribe a Stokes solution and can be thought of as velocity and pressure's equivalent of the initial conditions plugin.

Note: This can only be used if the nonlinear solver scheme is `single Advection, no Stokes'.

Definition at line 56 of file interface.h.

Constructor & Destructor Documentation

~Interface()

template<int dim>

virtual aspect::PrescribedStokesSolution::Interface< dim >::~Interface ( )

virtualdefault

Destructor. Made virtual to enforce that derived classes also have virtual destructors.

Member Function Documentation

initialize()

template<int dim>

virtual void aspect::PrescribedStokesSolution::Interface< dim >::initialize ( )

virtual

Initialization function. This function is called once at the beginning of the program after parse_parameters is run and after the SimulatorAccess (if applicable) is initialized.

Reimplemented in aspect::PrescribedStokesSolution::AsciiData< dim >.

update()

template<int dim>

virtual void aspect::PrescribedStokesSolution::Interface< dim >::update ( )

virtual

A function that is called at the beginning of each time step. The default implementation of the function does nothing, but derived classes that need more elaborate setups for a given time step may overload the function.

The point of this function is to allow complex prescribed Stokes solutions to do an initialization step once at the beginning of each time step. An example would be a time-dependent prescribed velocity.

Reimplemented in aspect::PrescribedStokesSolution::Function< dim >.

stokes_solution()

template<int dim>

virtual void aspect::PrescribedStokesSolution::Interface< dim >::stokes_solution ( const Point< dim > &  p, Vector< double > &  value  ) const

pure virtual

Given a position p, fill in desired velocity and pressure at that point into value, which will have dim+1 components. In value, the velocity components come first, followed by the pressure component.

Implemented in aspect::PrescribedStokesSolution::AsciiData< dim >, aspect::PrescribedStokesSolution::Function< dim >, and aspect::PrescribedStokesSolution::Circle< dim >.

declare_parameters()

template<int dim>

static void aspect::PrescribedStokesSolution::Interface< dim >::declare_parameters ( ParameterHandler &  prm )

static

Declare the parameters this class takes through input files. The default implementation of this function does not describe any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters.

parse_parameters()

template<int dim>

virtual void aspect::PrescribedStokesSolution::Interface< dim >::parse_parameters ( ParameterHandler &  prm )

virtual

Read the parameters this class declares from the parameter file. The default implementation of this function does not read any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters.

Reimplemented in aspect::PrescribedStokesSolution::AsciiData< dim >, and aspect::PrescribedStokesSolution::Function< dim >.

---

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

• /home/bob/source/include/aspect/prescribed_stokes_solution/interface.h