Inheritance diagram for aspect::BoundaryComposition::InitialComposition< dim >:

Public Member Functions
void	initialize () override

double	boundary_composition (const types::boundary_id boundary_indicator, const Point< dim > &position, const unsigned int compositional_field) const override

virtual double	minimal_composition (const std::set< types::boundary_id > &fixed_boundary_ids) const

virtual double	maximal_composition (const std::set< types::boundary_id > &fixed_boundary_ids) const

void	parse_parameters (ParameterHandler &prm) override

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

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
double	min_composition

double	max_composition

std::shared_ptr< const aspect::InitialComposition::Manager< dim > >	initial_composition

Detailed Description

template<int dim>
class aspect::BoundaryComposition::InitialComposition< dim >

A class that implements a composition boundary condition for a spherical shell geometry in which the composition at the inner and outer surfaces (i.e. at the core-mantle and the mantle-lithosphere/atmosphere boundaries) are constant.

Definition at line 43 of file initial_composition.h.

Member Function Documentation

§ initialize()

template<int dim>

void aspect::BoundaryComposition::InitialComposition< dim >::initialize ( )

overridevirtual

Initialization function. This function is called once at the beginning of the program after parse_parameters is run.

This specific function makes sure that the objects that describe initial conditions remain available throughout the run of the program.

Reimplemented from aspect::Plugins::InterfaceBase.

§ boundary_composition()

template<int dim>

double aspect::BoundaryComposition::InitialComposition< dim >::boundary_composition	(	const types::boundary_id	boundary_indicator,
		const Point< dim > &	position,
		const unsigned int	compositional_field
	)		const

overridevirtual

This function returns the boundary compositions that are defined by the initial conditions.

Return the composition that is to hold at a particular position on the boundary of the domain.

Parameters

boundary_indicator	The boundary indicator of the part of the boundary of the domain on which the point is located at which we are requesting the composition.
position	The position of the point at which we ask for the composition.
compositional_field	The index of the compositional field between 0 and `parameters.n_compositional_fields`.

Returns: Boundary value of the compositional field compositional_field at the position position.

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

§ minimal_composition()

template<int dim>

virtual double aspect::BoundaryComposition::InitialComposition< dim >::minimal_composition ( const std::set< types::boundary_id > & fixed_boundary_ids ) const

virtual

Return the minimal composition on that part of the boundary on which Dirichlet conditions are posed.

§ maximal_composition()

template<int dim>

virtual double aspect::BoundaryComposition::InitialComposition< dim >::maximal_composition ( const std::set< types::boundary_id > & fixed_boundary_ids ) const

virtual

Return the maximal composition on that part of the boundary on which Dirichlet conditions are posed.

§ declare_parameters()

template<int dim>

static void aspect::BoundaryComposition::InitialComposition< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters this class takes through input files. This class declares the inner and outer boundary compositions.

§ parse_parameters()

template<int dim>

void aspect::BoundaryComposition::InitialComposition< dim >::parse_parameters ( ParameterHandler & prm )

overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

§ min_composition

template<int dim>

double aspect::BoundaryComposition::InitialComposition< dim >::min_composition

private

Compositions at the inner and outer boundaries.

Definition at line 99 of file initial_composition.h.

§ max_composition

template<int dim>

double aspect::BoundaryComposition::InitialComposition< dim >::max_composition

private

Definition at line 100 of file initial_composition.h.

§ initial_composition

template<int dim>

std::shared_ptr<const aspect::InitialComposition::Manager<dim> > aspect::BoundaryComposition::InitialComposition< dim >::initial_composition

private

A shared pointer to the initial composition object that ensures that the current object can continue to access the initial composition object beyond the first time step.

Definition at line 108 of file initial_composition.h.

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

/home/bob/source/include/aspect/boundary_composition/initial_composition.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

template<int dim> class aspect::BoundaryComposition::InitialComposition< dim >

Member Function Documentation

§ initialize()

§ boundary_composition()

§ minimal_composition()

§ maximal_composition()

§ declare_parameters()

§ parse_parameters()

Member Data Documentation

§ min_composition

§ max_composition

§ initial_composition

template<int dim>
class aspect::BoundaryComposition::InitialComposition< dim >