Inheritance diagram for aspect::HeatingModel::Manager< dim >:

Public Member Functions
	~Manager () override

bool	adiabatic_heating_enabled () const

bool	shear_heating_enabled () const

void	parse_parameters (ParameterHandler &prm)

void	update ()

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

const std::vector< std::string > &	get_active_heating_model_names () const

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>>
bool	has_matching_heating_model () const

template<typename HeatingModelType , typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,HeatingModelType>::value>>
const HeatingModelType &	get_matching_heating_model () const

	DeclException1 (ExcHeatingModelNameNotFound, std::string,<< "Could not find entry <"<< arg1<< "> among the names of registered heating model objects.")

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::BlockVector &	get_current_linearization_point () const

const LinearAlgebra::BlockVector &	get_solution () const

const LinearAlgebra::BlockVector &	get_old_solution () const

const LinearAlgebra::BlockVector &	get_old_old_solution () const

const LinearAlgebra::BlockVector &	get_reaction_vector () const

const LinearAlgebra::BlockVector &	get_mesh_velocity () const

const DoFHandler< dim > &	get_dof_handler () const

const FiniteElement< dim > &	get_fe () const

const LinearAlgebra::BlockSparseMatrix &	get_system_matrix () const

const LinearAlgebra::BlockSparseMatrix &	get_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

const Particle::World< dim > &	get_particle_world () const

Particle::World< dim > &	get_particle_world ()

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::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::list< std::unique_ptr< Interface< dim > > >	heating_model_objects

std::vector< std::string >	model_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.

Constructor & Destructor Documentation

§ ~Manager()

template<int dim>

aspect::HeatingModel::Manager< dim >::~Manager ( )

override

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

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 )

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.

§ update()

template<int dim>

void aspect::HeatingModel::Manager< dim >::update ( )

A function that is called at the beginning of each time step, calling the update function of the individual heating models.

§ 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>

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.

§ get_active_heating_models()

template<int dim>

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.

§ has_matching_heating_model()

template<int dim>

template<typename HeatingModelType , typename >

bool aspect::HeatingModel::Manager< dim >::has_matching_heating_model ( ) const

inline

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.

Definition at line 405 of file interface.h.

§ get_matching_heating_model()

template<int dim>

template<typename HeatingModelType , typename >

const HeatingModelType & aspect::HeatingModel::Manager< dim >::get_matching_heating_model ( ) const

inline

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 casted 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.

Definition at line 418 of file interface.h.

References aspect::HeatingModel::get_valid_model_names_pattern().

§ 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_stream The stream to write the output to.

§ DeclException1()

template<int dim>

aspect::HeatingModel::Manager< dim >::DeclException1	(	ExcHeatingModelNameNotFound	,
		std::string
	)

Exception.

Member Data Documentation

§ heating_model_objects

template<int dim>

std::list<std::unique_ptr<Interface<dim> > > aspect::HeatingModel::Manager< dim >::heating_model_objects

private

A list of heating model objects that have been requested in the parameter file.

Definition at line 390 of file interface.h.

§ model_names

template<int dim>

std::vector<std::string> aspect::HeatingModel::Manager< dim >::model_names

private

A list of names of heating model objects that have been requested in the parameter file.

Definition at line 396 of file interface.h.

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

/home/bob/source/include/aspect/simulator_access.h
/home/bob/source/include/aspect/heating_model/interface.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

§ ~Manager()

Member Function Documentation

§ adiabatic_heating_enabled()

§ shear_heating_enabled()

§ declare_parameters()

§ parse_parameters()

§ update()

§ evaluate()

§ create_additional_material_model_inputs_and_outputs()

§ get_active_heating_model_names()

§ get_active_heating_models()

§ has_matching_heating_model()

§ get_matching_heating_model()

§ write_plugin_graph()

§ DeclException1()

Member Data Documentation

§ heating_model_objects

§ model_names

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