ASPECT
Namespaces | Classes | Macros | Functions
Describing traction boundary conditions for the velocity field
Collaboration diagram for Describing traction boundary conditions for the velocity field:

Namespaces

 aspect::BoundaryTraction
 

Classes

class  aspect::BoundaryTraction::AsciiData< dim >
 
class  aspect::BoundaryTraction::Function< dim >
 
class  aspect::BoundaryTraction::InitialLithostaticPressure< dim >
 
class  aspect::BoundaryTraction::Interface< dim >
 
class  aspect::BoundaryTraction::ZeroTraction< dim >
 

Macros

#define ASPECT_REGISTER_BOUNDARY_TRACTION_MODEL(classname, name, description)
 

Functions

template<int dim>
void aspect::BoundaryTraction::register_boundary_traction (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), Interface< dim > *(*factory_function)())
 
template<int dim>
Interface< dim > * aspect::BoundaryTraction::create_boundary_traction (const std::string &name)
 
template<int dim>
void aspect::BoundaryTraction::declare_parameters (ParameterHandler &prm)
 

Detailed Description

A module for the definition of functions and classes that have to do with describing traction boundary values for the velocity field.

Macro Definition Documentation

§ ASPECT_REGISTER_BOUNDARY_TRACTION_MODEL

#define ASPECT_REGISTER_BOUNDARY_TRACTION_MODEL (   classname,
  name,
  description 
)
Value:
template class classname<2>; \
template class classname<3>; \
namespace ASPECT_REGISTER_BOUNDARY_TRACTION_MODEL_ ## classname \
{ \
aspect::internal::Plugins::RegisterHelper<aspect::BoundaryTraction::Interface<2>,classname<2> > \
dummy_ ## classname ## _2d (&aspect::BoundaryTraction::register_boundary_traction<2>, \
name, description); \
aspect::internal::Plugins::RegisterHelper<aspect::BoundaryTraction::Interface<3>,classname<3> > \
dummy_ ## classname ## _3d (&aspect::BoundaryTraction::register_boundary_traction<3>, \
name, description); \
}

Given a class name, a name, and a description for the parameter file for a traction boundary conditions model, register it with the functions that can declare their parameters and create these objects.

Definition at line 214 of file interface.h.

Function Documentation

§ register_boundary_traction()

template<int dim>
void aspect::BoundaryTraction::register_boundary_traction ( const std::string &  name,
const std::string &  description,
void(*)(ParameterHandler &)  declare_parameters_function,
Interface< dim > *(*)()  factory_function 
)

Register a traction boundary conditions model so that it can be selected from the parameter file.

Parameters
nameA string that identifies the traction boundary conditions model
descriptionA text description of what this model does and that will be listed in the documentation of the parameter file.
declare_parameters_functionA pointer to a function that can be used to declare the parameters that this traction boundary conditions model wants to read from input files.
factory_functionA pointer to a function that can create an object of this traction boundary conditions model.

§ create_boundary_traction()

template<int dim>
Interface<dim>* aspect::BoundaryTraction::create_boundary_traction ( const std::string &  name)

A function that given the name of a model returns a pointer to an object that describes it. Ownership of the pointer is transferred to the caller.

The model object returned is not yet initialized and has not read its runtime parameters yet.

§ declare_parameters()

template<int dim>
void aspect::BoundaryTraction::declare_parameters ( ParameterHandler prm)

Declare the runtime parameters of the registered traction boundary conditions models.