ASPECT
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
aspect::BoundaryVelocity::Manager< dim > Class Template Reference
Inheritance diagram for aspect::BoundaryVelocity::Manager< dim >:
Inheritance graph
[legend]

Public Member Functions

virtual ~Manager ()
 
virtual void update ()
 
Tensor< 1, dim > boundary_velocity (const types::boundary_id boundary_indicator, const Point< dim > &position) const
 
const std::map< types::boundary_id, std::pair< std::string, std::vector< std::string > > > & get_active_boundary_velocity_names () const
 
const std::map< types::boundary_id, std::vector< std::unique_ptr< BoundaryVelocity::Interface< dim > > > > & get_active_boundary_velocity_conditions () const
 
const std::set< types::boundary_id > & get_zero_boundary_velocity_indicators () const
 
const std::set< types::boundary_id > & get_tangential_boundary_velocity_indicators () const
 
void parse_parameters (ParameterHandler &prm)
 
template<typename BoundaryVelocityType >
DEAL_II_DEPRECATED BoundaryVelocityType * find_boundary_velocity_model () const
 
template<typename BoundaryVelocityType >
bool has_matching_boundary_velocity_model () const
 
template<typename BoundaryVelocityType >
const BoundaryVelocityType & get_matching_boundary_velocity_model () const
 
 DeclException1 (ExcBoundaryVelocityNameNotFound, std::string,<< "Could not find entry <"<< arg1<< "> among the names of registered boundary velocity objects.")
 
template<typename BoundaryVelocityType >
BoundaryVelocityType * find_boundary_velocity_model () const
 
- Public Member Functions inherited from aspect::SimulatorAccess< dim >
 SimulatorAccess ()
 
 SimulatorAccess (const Simulator< dim > &simulator_object)
 
virtual ~SimulatorAccess ()
 
virtual void initialize_simulator (const Simulator< dim > &simulator_object)
 
template<typename PostprocessorType >
PostprocessorType * find_postprocessor () const
 
const Introspection< dim > & introspection () const
 
const Simulator< dim > & get_simulator () const
 
const Parameters< dim > & get_parameters () const
 
SimulatorSignals< dim > & get_signals () const
 
MPI_Comm get_mpi_communicator () const
 
TimerOutputget_computing_timer () const
 
const ConditionalOStreamget_pcout () const
 
double get_time () const
 
double get_timestep () const
 
double get_old_timestep () const
 
unsigned int get_timestep_number () const
 
unsigned int get_nonlinear_iteration () const
 
const parallel::distributed::Triangulation< dim > & get_triangulation () const
 
double get_volume () const
 
const Mapping< dim > & get_mapping () const
 
std::string get_output_directory () const
 
bool include_adiabatic_heating () const
 
bool include_latent_heat () const
 
bool include_melt_transport () const
 
int get_stokes_velocity_degree () const
 
double get_adiabatic_surface_temperature () const
 
double get_surface_pressure () const
 
bool convert_output_to_years () const
 
unsigned int get_pre_refinement_step () const
 
unsigned int n_compositional_fields () const
 
void get_refinement_criteria (Vector< float > &estimated_error_per_cell) const
 
void get_artificial_viscosity (Vector< float > &viscosity_per_cell, const bool skip_interior_cells=false) const
 
void get_artificial_viscosity_composition (Vector< float > &viscosity_per_cell, const unsigned int compositional_variable) const
 
const LinearAlgebra::BlockVectorget_current_linearization_point () const
 
const LinearAlgebra::BlockVectorget_solution () const
 
const LinearAlgebra::BlockVectorget_old_solution () const
 
const LinearAlgebra::BlockVectorget_old_old_solution () const
 
const LinearAlgebra::BlockVectorget_reaction_vector () const
 
const LinearAlgebra::BlockVectorget_mesh_velocity () const
 
const DoFHandler< dim > & get_dof_handler () const
 
const FiniteElement< dim > & get_fe () const
 
const LinearAlgebra::BlockSparseMatrixget_system_matrix () const
 
const LinearAlgebra::BlockSparseMatrixget_system_preconditioner_matrix () const
 
const MaterialModel::Interface< dim > & get_material_model () const
 
void compute_material_model_input_values (const LinearAlgebra::BlockVector &input_solution, const FEValuesBase< dim, dim > &input_finite_element_values, const typename DoFHandler< dim >::active_cell_iterator &cell, const bool compute_strainrate, MaterialModel::MaterialModelInputs< dim > &material_model_inputs) const
 
const GravityModel::Interface< dim > & get_gravity_model () const
 
const InitialTopographyModel::Interface< dim > & get_initial_topography_model () const
 
const GeometryModel::Interface< dim > & get_geometry_model () const
 
const AdiabaticConditions::Interface< dim > & get_adiabatic_conditions () const
 
bool has_boundary_temperature () const
 
DEAL_II_DEPRECATED const BoundaryTemperature::Interface< dim > & get_boundary_temperature () const
 
const BoundaryTemperature::Manager< dim > & get_boundary_temperature_manager () const
 
const BoundaryHeatFlux::Interface< dim > & get_boundary_heat_flux () const
 
bool has_boundary_composition () const
 
DEAL_II_DEPRECATED const BoundaryComposition::Interface< dim > & get_boundary_composition () const
 
const BoundaryComposition::Manager< dim > & get_boundary_composition_manager () const
 
const std::map< types::boundary_id, std::unique_ptr< BoundaryTraction::Interface< dim > > > & get_boundary_traction () const
 
DEAL_II_DEPRECATED const InitialTemperature::Interface< dim > & get_initial_temperature () const
 
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
 
DEAL_II_DEPRECATED const InitialComposition::Interface< dim > & get_initial_composition () const
 
const InitialComposition::Manager< dim > & get_initial_composition_manager () const
 
const std::set< types::boundary_id > & get_fixed_temperature_boundary_indicators () const
 
const std::set< types::boundary_id > & get_fixed_heat_flux_boundary_indicators () const
 
const std::set< types::boundary_id > & get_fixed_composition_boundary_indicators () const
 
const std::set< types::boundary_id > & get_free_surface_boundary_indicators () const
 
const BoundaryVelocity::Manager< dim > & get_boundary_velocity_manager () const
 
const HeatingModel::Manager< dim > & get_heating_model_manager () const
 
const MeshRefinement::Manager< dim > & get_mesh_refinement_manager () const
 
const MeltHandler< dim > & get_melt_handler () const
 
const VolumeOfFluidHandler< dim > & get_volume_of_fluid_handler () const
 
const NewtonHandler< dim > & get_newton_handler () const
 
const WorldBuilder::World & get_world_builder () const
 
const FreeSurfaceHandler< dim > & get_free_surface_handler () const
 
const LateralAveraging< dim > & get_lateral_averaging () const
 
const ConstraintMatrix & get_current_constraints () const
 
bool simulator_is_initialized () const
 
double get_pressure_scaling () const
 
bool pressure_rhs_needs_compatibility_modification () const
 
bool model_has_prescribed_stokes_solution () const
 
TableHandlerget_statistics_object () const
 
template<typename PostprocessorType >
DEAL_II_DEPRECATED PostprocessorType * find_postprocessor () const
 
const Postprocess::Manager< dim > & get_postprocess_manager () const
 

Static Public Member Functions

static void register_boundary_velocity (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), Interface< dim > *(*factory_function)())
 
static void declare_parameters (ParameterHandler &prm)
 
static void write_plugin_graph (std::ostream &output_stream)
 
- Static Public Member Functions inherited from aspect::SimulatorAccess< dim >
static void get_composition_values_at_q_point (const std::vector< std::vector< double > > &composition_values, const unsigned int q, std::vector< double > &composition_values_at_q_point)
 

Private Attributes

std::map< types::boundary_id, std::vector< std::unique_ptr< BoundaryVelocity::Interface< dim > > > > boundary_velocity_objects
 
std::map< types::boundary_id, std::pair< std::string, std::vector< std::string > > > boundary_velocity_indicators
 
std::set< types::boundary_idzero_velocity_boundary_indicators
 
std::set< types::boundary_idtangential_velocity_boundary_indicators
 

Detailed Description

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

A class that manages all boundary velocity objects.

Definition at line 109 of file simulator_access.h.

Constructor & Destructor Documentation

§ ~Manager()

template<int dim>
virtual aspect::BoundaryVelocity::Manager< dim >::~Manager ( )
virtual

Destructor. Made virtual since this class has virtual member functions.

Member Function Documentation

§ update()

template<int dim>
virtual void aspect::BoundaryVelocity::Manager< dim >::update ( )
virtual

A function that is called at the beginning of each time step and calls the corresponding functions of all created plugins.

The point of this function is to allow complex boundary velocity models to do an initialization step once at the beginning of each time step. An example would be a model that needs to call an external program to compute the velocity change at a boundary.

§ boundary_velocity()

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

A function that calls the boundary_velocity functions of all the individual boundary velocity objects and uses the stored operators to combine them.

§ register_boundary_velocity()

template<int dim>
static void aspect::BoundaryVelocity::Manager< dim >::register_boundary_velocity ( const std::string &  name,
const std::string &  description,
void(*)(ParameterHandler &)  declare_parameters_function,
Interface< dim > *(*)()  factory_function 
)
static

A function that is used to register boundary velocity objects in such a way that the Manager can deal with all of them without having to know them by name. This allows the files in which individual plugins are implemented to register these plugins, rather than also having to modify the Manager class by adding the new boundary velocity plugin class.

Parameters
nameA string that identifies the boundary velocity 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 boundary velocity model wants to read from input files.
factory_functionA pointer to a function that can create an object of this boundary velocity model.

§ get_active_boundary_velocity_names()

template<int dim>
const std::map<types::boundary_id, std::pair<std::string,std::vector<std::string> > >& aspect::BoundaryVelocity::Manager< dim >::get_active_boundary_velocity_names ( ) const

Return the names of all prescribed boundary velocity models currently used in the computation as specified in the input file. The function returns a map between a boundary identifier and a pair. The first part of the pair is a string that represents the prescribed velocity components on this boundary (e.g. y, xz, or xyz) and the second part is a vector of strings that represent the names of boundary velocity plugins for this boundary. If there are no prescribed boundary velocity plugins for a particular boundary, this boundary identifier will not appear in the map.

§ get_active_boundary_velocity_conditions()

template<int dim>
const std::map<types::boundary_id,std::vector<std::unique_ptr<BoundaryVelocity::Interface<dim> > > >& aspect::BoundaryVelocity::Manager< dim >::get_active_boundary_velocity_conditions ( ) const

Return pointers to all boundary velocity models currently used in the computation, as specified in the input file. The function returns a map between a boundary identifier and a vector of unique pointers that represent the names of prescribed velocity boundary models for this boundary. If there are no prescribed boundary velocity plugins for a particular boundary this boundary identifier will not appear in the map.

§ get_zero_boundary_velocity_indicators()

template<int dim>
const std::set<types::boundary_id>& aspect::BoundaryVelocity::Manager< dim >::get_zero_boundary_velocity_indicators ( ) const

Return a list of boundary ids on which the velocity is prescribed to be zero (no-slip).

§ get_tangential_boundary_velocity_indicators()

template<int dim>
const std::set<types::boundary_id>& aspect::BoundaryVelocity::Manager< dim >::get_tangential_boundary_velocity_indicators ( ) const

Return a list of boundary ids on which the velocity is prescribed to be tangential (free-slip).

§ declare_parameters()

template<int dim>
static void aspect::BoundaryVelocity::Manager< dim >::declare_parameters ( ParameterHandler prm)
static

Declare the parameters of all known boundary velocity plugins, as well as the ones this class has itself.

§ parse_parameters()

template<int dim>
void aspect::BoundaryVelocity::Manager< dim >::parse_parameters ( ParameterHandler prm)

Read the parameters this class declares from the parameter file. This determines which boundary velocity objects will be created; then let these objects read their parameters as well.

§ find_boundary_velocity_model() [1/2]

template<int dim>
template<typename BoundaryVelocityType >
DEAL_II_DEPRECATED BoundaryVelocityType* aspect::BoundaryVelocity::Manager< dim >::find_boundary_velocity_model ( ) const

Go through the list of all boundary velocity models that have been selected in the input file (and are consequently currently active) and see if one of them has the desired type specified by the template argument. If so, return a pointer to it. If no boundary velocity model is active that matches the given type, return a nullptr.

§ has_matching_boundary_velocity_model()

template<int dim>
template<typename BoundaryVelocityType >
bool aspect::BoundaryVelocity::Manager< dim >::has_matching_boundary_velocity_model ( ) const
inline

Go through the list of all boundary velocity models that have been selected in the input file (and are consequently currently active) and return true if one of them has the desired type specified by the template argument.

Definition at line 342 of file interface.h.

§ get_matching_boundary_velocity_model()

template<int dim>
template<typename BoundaryVelocityType >
const BoundaryVelocityType & aspect::BoundaryVelocity::Manager< dim >::get_matching_boundary_velocity_model ( ) const
inline

Go through the list of all boundary velocity models that have been selected in the input file (and are consequently currently active) and see if one of them has the type specified by the template argument or can be casted to that type. If so, return a reference to it. If no boundary velocity model is active that matches the given type, throw an exception.

Definition at line 356 of file interface.h.

References AssertThrow, ExcMessage(), and aspect::BoundaryVelocity::get_valid_model_names_pattern().

§ write_plugin_graph()

template<int dim>
static void aspect::BoundaryVelocity::Manager< dim >::write_plugin_graph ( std::ostream &  output_stream)
static

For the current plugin subsystem, write a connection graph of all of the plugins we know about, in the format that the programs dot and neato understand. This allows for a visualization of how all of the plugins that ASPECT knows about are interconnected, and connect to other parts of the ASPECT code.

Parameters
output_streamThe stream to write the output to.

§ DeclException1()

template<int dim>
aspect::BoundaryVelocity::Manager< dim >::DeclException1 ( ExcBoundaryVelocityNameNotFound  ,
std::string   
)

Exception.

§ find_boundary_velocity_model() [2/2]

template<int dim>
template<typename BoundaryVelocityType >
BoundaryVelocityType* aspect::BoundaryVelocity::Manager< dim >::find_boundary_velocity_model ( ) const
inline

Definition at line 328 of file interface.h.

Member Data Documentation

§ boundary_velocity_objects

template<int dim>
std::map<types::boundary_id,std::vector<std::unique_ptr<BoundaryVelocity::Interface<dim> > > > aspect::BoundaryVelocity::Manager< dim >::boundary_velocity_objects
private

A list of boundary velocity objects that have been requested in the parameter file.

Definition at line 297 of file interface.h.

§ boundary_velocity_indicators

template<int dim>
std::map<types::boundary_id, std::pair<std::string,std::vector<std::string> > > aspect::BoundaryVelocity::Manager< dim >::boundary_velocity_indicators
private

Map from boundary id to a pair ("components", list of "velocity boundary type"), where components is of the format "[x][y][z]" and the velocity type is mapped to one of the plugins of velocity boundary conditions (e.g. "function"). If the components string is empty, it is assumed the plugins are used for all components.

Definition at line 307 of file interface.h.

§ zero_velocity_boundary_indicators

template<int dim>
std::set<types::boundary_id> aspect::BoundaryVelocity::Manager< dim >::zero_velocity_boundary_indicators
private

A set of boundary indicators, on which velocities are prescribed to zero (no-slip).

Definition at line 313 of file interface.h.

§ tangential_velocity_boundary_indicators

template<int dim>
std::set<types::boundary_id> aspect::BoundaryVelocity::Manager< dim >::tangential_velocity_boundary_indicators
private

A set of boundary indicators, on which velocities are prescribed to be tangential (free-slip).

Definition at line 319 of file interface.h.


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