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

Public Member Functions
void	evaluate (const MaterialModel::MaterialModelInputs< dim > &material_model_inputs, const MaterialModel::MaterialModelOutputs< dim > &material_model_outputs, HeatingModel::HeatingModelOutputs &heating_model_outputs) const override

void	parse_parameters (ParameterHandler &prm) override

Public Member Functions inherited from aspect::HeatingModel::Interface< dim >
virtual void	create_additional_material_model_outputs (MaterialModel::MaterialModelOutputs< dim > &outputs) const

virtual void	create_additional_material_model_inputs (MaterialModel::MaterialModelInputs< dim > &inputs) const

Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual	~InterfaceBase ()=default

virtual void	initialize ()

virtual void	update ()

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

unsigned int	n_particle_managers () const

const Particle::Manager< dim > &	get_particle_manager (const unsigned int particle_manager_index) const

Particle::Manager< dim > &	get_particle_manager (const unsigned int particle_manager_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 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)

Private Attributes
std::vector< double >	heating_values

std::vector< bool >	fields_used_in_heat_production_averaging

bool	use_background_field_for_heat_production_averaging

Detailed Description

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

A class that implements a heating model where each compositional field is assigned a user-defined internal heating value.

Definition at line 42 of file compositional_heating.h.

Member Function Documentation

§ evaluate()

template<int dim>

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

overridevirtual

Return the magnitude of heat production arising from values assigned to each compositional field.

Implements aspect::HeatingModel::Interface< dim >.

§ declare_parameters()

template<int dim>

static void aspect::HeatingModel::CompositionalHeating< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>

void aspect::HeatingModel::CompositionalHeating< dim >::parse_parameters ( ParameterHandler & prm )

overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

§ heating_values

template<int dim>

std::vector<double> aspect::HeatingModel::CompositionalHeating< dim >::heating_values

private

Magnitude of heat production for each compositional field

Definition at line 71 of file compositional_heating.h.

§ fields_used_in_heat_production_averaging

template<int dim>

std::vector<bool> aspect::HeatingModel::CompositionalHeating< dim >::fields_used_in_heat_production_averaging

private

A vector with as many entries as compositional fields. If the entry for a particular field is true the field is considered during the averaging of heat production rates, if not the field is ignored. This is useful if some compositional fields are used to track properties like finite strain that should not contribute to heat production.

Definition at line 81 of file compositional_heating.h.

§ use_background_field_for_heat_production_averaging

template<int dim>

bool aspect::HeatingModel::CompositionalHeating< dim >::use_background_field_for_heat_production_averaging

private

Similar to fields_used_in_heat_production_averaging, except it determines whether to include the background field in the heat production computation.

Definition at line 88 of file compositional_heating.h.

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

/home/bob/source/include/aspect/heating_model/compositional_heating.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

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

Member Function Documentation

§ evaluate()

§ declare_parameters()

§ parse_parameters()

Member Data Documentation

§ heating_values

§ fields_used_in_heat_production_averaging

§ use_background_field_for_heat_production_averaging

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