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

[legend]

Public Member Functions
	RadioactiveDecay ()

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

MaterialModel::MaterialProperties::Property	get_required_properties () 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 ()

virtual void	save (std::map< std::string, std::string > &status_strings) const

virtual void	load (const std::map< std::string, std::string > &status_strings)

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)

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

unsigned int	get_checkpoint_id () 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 std::shared_ptr< const InitialTopographyModel::Interface< dim > >	get_initial_topography_model_pointer () 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 BoundaryConvectiveHeating::Manager< dim > &	get_boundary_convective_heating_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_convective_heating_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

const PrescribedSolution::Manager< dim > &	get_prescribed_solution () const

RotationProperties< dim >	compute_net_angular_momentum (const bool use_constant_density, const LinearAlgebra::BlockVector &solution, const bool limit_to_top_faces=false) const

void	remove_nullspace (LinearAlgebra::BlockVector &solution, LinearAlgebra::BlockVector &distributed_stokes_solution) const

double	normalize_pressure (LinearAlgebra::BlockVector &vector) const

void	denormalize_pressure (const double pressure_adjustment, LinearAlgebra::BlockVector &vector) 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
unsigned int	n_radio_heating_elements

std::vector< double >	half_decay_times

std::vector< double >	radioactive_heating_rates

std::vector< double >	radioactive_initial_concentrations_crust

std::vector< double >	radioactive_initial_concentrations_mantle

bool	is_crust_defined_by_composition

double	crust_depth

unsigned int	crust_composition_num

Detailed Description

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

A class that implements a heating model based on radioactive decay.

Definition at line 41 of file radioactive_decay.h.

Constructor & Destructor Documentation

◆ RadioactiveDecay()

template<int dim>

aspect::HeatingModel::RadioactiveDecay< dim >::RadioactiveDecay ( )

Constructor.

Member Function Documentation

◆ evaluate()

template<int dim>

void aspect::HeatingModel::RadioactiveDecay< 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 specific heating rate as calculated by radioactive decay.

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

◆ get_required_properties()

template<int dim>

MaterialModel::MaterialProperties::Property aspect::HeatingModel::RadioactiveDecay< dim >::get_required_properties ( ) const

overridevirtual

Specify which material model outputs the heating model requires for computing the heating terms.

Reimplemented from aspect::HeatingModel::Interface< dim >.

◆ declare_parameters()

template<int dim>

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

static

Declare the parameters this class takes through input files.

◆ parse_parameters()

template<int dim>

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

overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

◆ n_radio_heating_elements

template<int dim>

unsigned int aspect::HeatingModel::RadioactiveDecay< dim >::n_radio_heating_elements

private

Number of radioactive heating elements. This variable is read from the parameter file through the 'Number of elements' parameter.

Definition at line 84 of file radioactive_decay.h.

◆ half_decay_times

template<int dim>

std::vector<double> aspect::HeatingModel::RadioactiveDecay< dim >::half_decay_times

private

Half-lives of different elements. This variable is read from the parameter file through the 'Half decay times' parameter.

Definition at line 90 of file radioactive_decay.h.

◆ radioactive_heating_rates

template<int dim>

std::vector<double> aspect::HeatingModel::RadioactiveDecay< dim >::radioactive_heating_rates

private

Unit heating rates of different elements. This variable is read from the parameter file through the 'Heating rates' parameter.

Definition at line 96 of file radioactive_decay.h.

◆ radioactive_initial_concentrations_crust

template<int dim>

std::vector<double> aspect::HeatingModel::RadioactiveDecay< dim >::radioactive_initial_concentrations_crust

private

Initial concentrations in the crust. This variable is read from the parameter file through the 'Initial concentrations crust' parameter.

Definition at line 102 of file radioactive_decay.h.

◆ radioactive_initial_concentrations_mantle

template<int dim>

std::vector<double> aspect::HeatingModel::RadioactiveDecay< dim >::radioactive_initial_concentrations_mantle

private

Initial concentrations in the mantle. This variable is read from the parameter file through the 'Initial concentrations mantle' parameter.

Definition at line 108 of file radioactive_decay.h.

◆ is_crust_defined_by_composition

template<int dim>

bool aspect::HeatingModel::RadioactiveDecay< dim >::is_crust_defined_by_composition

private

Whether the crust is defined by composition or depth. This variable is read from the parameter file through the 'Crust defined by composition' parameter.

Definition at line 115 of file radioactive_decay.h.

◆ crust_depth

template<int dim>

double aspect::HeatingModel::RadioactiveDecay< dim >::crust_depth

private

Depth of the crust. This variable is read from the parameter file through the 'Crust depth' parameter.

Definition at line 121 of file radioactive_decay.h.

◆ crust_composition_num

template<int dim>

unsigned int aspect::HeatingModel::RadioactiveDecay< dim >::crust_composition_num

private

Composition number of the crust. This variable is read from the parameter file through the 'Crust composition number' parameter.

Definition at line 127 of file radioactive_decay.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/latest/include/aspect/heating_model/radioactive_decay.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ RadioactiveDecay()

Member Function Documentation

◆ evaluate()

◆ get_required_properties()

◆ declare_parameters()

◆ parse_parameters()

Member Data Documentation

◆ n_radio_heating_elements

◆ half_decay_times

◆ radioactive_heating_rates

◆ radioactive_initial_concentrations_crust

◆ radioactive_initial_concentrations_mantle

◆ is_crust_defined_by_composition

◆ crust_depth

◆ crust_composition_num

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