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

Public Member Functions

bool adiabatic_heating_enabled () const
 
bool shear_heating_enabled () const
 
void parse_parameters (ParameterHandler &prm) override
 
void evaluate (const MaterialModel::MaterialModelInputs< dim > &material_model_inputs, const MaterialModel::MaterialModelOutputs< dim > &material_model_outputs, HeatingModel::HeatingModelOutputs &heating_model_outputs) const
 
virtual void create_additional_material_model_inputs_and_outputs (MaterialModel::MaterialModelInputs< dim > &material_model_inputs, MaterialModel::MaterialModelOutputs< dim > &material_model_outputs) const
 
DEAL_II_DEPRECATED const std::vector< std::string > & get_active_heating_model_names () const
 
DEAL_II_DEPRECATED const std::list< std::unique_ptr< Interface< dim > > > & get_active_heating_models () const
 
template<typename HeatingModelType , typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,HeatingModelType>::value>>
DEAL_II_DEPRECATED bool has_matching_heating_model () const
 
template<typename HeatingModelType , typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,HeatingModelType>::value>>
DEAL_II_DEPRECATED const HeatingModelType & get_matching_heating_model () const
 
 DeclException1 (ExcHeatingModelNameNotFound, std::string,<< "Could not find entry <"<< arg1<< "> among the names of registered heating model objects.")
 
template<typename HeatingModelType , typename >
bool has_matching_heating_model () const
 
template<typename HeatingModelType , typename >
const HeatingModelType & get_matching_heating_model () const
 
- Public Member Functions inherited from aspect::Plugins::ManagerBase< Interface< dim > >
 ~ManagerBase () override
 
void update () override
 
bool has_matching_active_plugin () const
 
const PluginType & get_matching_active_plugin () const
 
const std::list< std::unique_ptr< Interface< dim > > > & get_active_plugins () const
 
const std::vector< std::string > & get_active_plugin_names () const
 
- Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual ~InterfaceBase ()=default
 
virtual void initialize ()
 
- Public Member Functions inherited from aspect::SimulatorAccess< dim >
 SimulatorAccess ()
 
 SimulatorAccess (const Simulator< dim > &simulator_object)
 
virtual ~SimulatorAccess ()=default
 
virtual void initialize_simulator (const Simulator< dim > &simulator_object)
 
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
 
TimerOutput & get_computing_timer () const
 
const ConditionalOStream & get_pcout () const
 
double get_time () const
 
double get_timestep () const
 
double get_old_timestep () const
 
unsigned int get_timestep_number () const
 
const TimeStepping::Manager< dim > & get_timestepping_manager () 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
 
double get_end_time () 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
 
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
 
const BoundaryTemperature::Manager< dim > & get_boundary_temperature_manager () const
 
const BoundaryHeatFlux::Interface< dim > & get_boundary_heat_flux () const
 
bool has_boundary_composition () const
 
const BoundaryComposition::Manager< dim > & get_boundary_composition_manager () const
 
const BoundaryTraction::Manager< dim > & get_boundary_traction_manager () const
 
std::shared_ptr< const InitialTemperature::Manager< dim > > get_initial_temperature_manager_pointer () const
 
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
 
std::shared_ptr< const InitialComposition::Manager< dim > > get_initial_composition_manager_pointer () 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_mesh_deformation_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 MeshDeformation::MeshDeformationHandler< dim > & get_mesh_deformation_handler () const
 
const LateralAveraging< dim > & get_lateral_averaging () const
 
const AffineConstraints< double > & get_current_constraints () const
 
bool simulator_is_past_initialization () const
 
double get_pressure_scaling () const
 
bool pressure_rhs_needs_compatibility_modification () const
 
bool model_has_prescribed_stokes_solution () const
 
TableHandler & get_statistics_object () const
 
const Postprocess::Manager< dim > & get_postprocess_manager () const
 
unsigned int n_particle_worlds () const
 
const Particle::World< dim > & get_particle_world (const unsigned int particle_world_index) const
 
Particle::World< dim > & get_particle_world (const unsigned int particle_world_index)
 
bool is_stokes_matrix_free ()
 
const StokesMatrixFreeHandler< dim > & get_stokes_matrix_free () const
 
RotationProperties< dim > compute_net_angular_momentum (const bool use_constant_density, const LinearAlgebra::BlockVector &solution, const bool limit_to_top_faces=false) const
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
static void register_heating_model (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), std::unique_ptr< Interface< dim >>(*factory_function)())
 
static void write_plugin_graph (std::ostream &output_stream)
 
- Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void declare_parameters (ParameterHandler &prm)
 
- 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)
 

Additional Inherited Members

- Protected Attributes inherited from aspect::Plugins::ManagerBase< Interface< dim > >
std::list< std::unique_ptr< Interface< dim > > > plugin_objects
 
std::vector< std::string > plugin_names
 

Detailed Description

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

A class that manages all objects that provide functionality to the heating models.

Definition at line 60 of file simulator_access.h.

Member Function Documentation

§ adiabatic_heating_enabled()

template<int dim>
bool aspect::HeatingModel::Manager< dim >::adiabatic_heating_enabled ( ) const

Returns true if the adiabatic heating plugin is found in the list of active heating models.

§ shear_heating_enabled()

template<int dim>
bool aspect::HeatingModel::Manager< dim >::shear_heating_enabled ( ) const

Returns true if the shear heating plugin is found in the list of active heating models.

§ declare_parameters()

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

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

§ parse_parameters()

template<int dim>
void aspect::HeatingModel::Manager< dim >::parse_parameters ( ParameterHandler &  prm)
overridevirtual

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

Reimplemented from aspect::Plugins::InterfaceBase.

§ evaluate()

template<int dim>
void aspect::HeatingModel::Manager< dim >::evaluate ( const MaterialModel::MaterialModelInputs< dim > &  material_model_inputs,
const MaterialModel::MaterialModelOutputs< dim > &  material_model_outputs,
HeatingModel::HeatingModelOutputs heating_model_outputs 
) const

A function that calls the evaluate function of all the individual heating models and adds up the values of the individual heating model outputs.

§ create_additional_material_model_inputs_and_outputs()

template<int dim>
virtual void aspect::HeatingModel::Manager< dim >::create_additional_material_model_inputs_and_outputs ( MaterialModel::MaterialModelInputs< dim > &  material_model_inputs,
MaterialModel::MaterialModelOutputs< dim > &  material_model_outputs 
) const
virtual

Allow the heating model plugins to attach additional material model inputs and outputs by looping over all registered plugins and calling their respective member functions.

§ get_active_heating_model_names()

template<int dim>
DEAL_II_DEPRECATED const std::vector<std::string>& aspect::HeatingModel::Manager< dim >::get_active_heating_model_names ( ) const

Return a list of names of all heating models currently used in the computation, as specified in the input file.

Deprecated:
Use Plugins::ManagerBase::get_active_plugin_names() instead.

§ get_active_heating_models()

template<int dim>
DEAL_II_DEPRECATED const std::list<std::unique_ptr<Interface<dim> > >& aspect::HeatingModel::Manager< dim >::get_active_heating_models ( ) const

Return a list of pointers to all heating models currently used in the computation, as specified in the input file.

Deprecated:
Use Plugins::ManagerBase::get_active_plugin_names() instead.

§ has_matching_heating_model() [1/2]

template<int dim>
template<typename HeatingModelType , typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,HeatingModelType>::value>>
DEAL_II_DEPRECATED bool aspect::HeatingModel::Manager< dim >::has_matching_heating_model ( ) const

Go through the list of all heating 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.

This function can only be called if the given template type (the first template argument) is a class derived from the Interface class in this namespace.

Deprecated:
Instead of this function, use the Plugins::ManagerBase::has_matching_active_plugin() and Plugins::ManagerBase::get_matching_active_plugin() functions of the base class of the current class.

§ get_matching_heating_model() [1/2]

template<int dim>
template<typename HeatingModelType , typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,HeatingModelType>::value>>
DEAL_II_DEPRECATED const HeatingModelType& aspect::HeatingModel::Manager< dim >::get_matching_heating_model ( ) const

Go through the list of all heating 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 cast to that type. If so, return a reference to it. If no heating model is active that matches the given type, throw an exception.

This function can only be called if the given template type (the first template argument) is a class derived from the Interface class in this namespace.

Deprecated:
Instead of this function, use the Plugins::ManagerBase::has_matching_active_plugin() and Plugins::ManagerBase::get_matching_active_plugin() functions of the base class of the current class.

§ write_plugin_graph()

template<int dim>
static void aspect::HeatingModel::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::HeatingModel::Manager< dim >::DeclException1 ( ExcHeatingModelNameNotFound  ,
std::string   
)

Exception.

§ has_matching_heating_model() [2/2]

template<int dim>
template<typename HeatingModelType , typename >
bool aspect::HeatingModel::Manager< dim >::has_matching_heating_model ( ) const
inline

Definition at line 348 of file interface.h.

§ get_matching_heating_model() [2/2]

template<int dim>
template<typename HeatingModelType , typename >
const HeatingModelType& aspect::HeatingModel::Manager< dim >::get_matching_heating_model ( ) const
inline

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