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

Public Member Functions
void	initialize () override

double	initial_composition (const Point< dim > &position, const unsigned int n_comp) const override

void	parse_parameters (ParameterHandler &prm) override

const Utilities::AsciiDataBoundary< dim > &	get_slab_boundary () const

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
Utilities::AsciiDataBoundary< dim >	slab_boundary

types::boundary_id	surface_boundary_id

unsigned int	slab_index

Detailed Description

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

A class that implements subducted slab geometries as a compositional field determined from an input file. The file defines the depth to the top of the slab and the slab thickness.

An example model that is included is Slab2 described in Hayes, G. P., Moore, G. L., Portner, D. E., Hearne, M., Flamme, H., Furtney, M., & Smoczyk, G. M. (2018). Slab2, a comprehensive subduction zone geometry model. Science, 362(6410), 58-61.

Definition at line 50 of file slab_model.h.

Member Function Documentation

§ initialize()

template<int dim>

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

overridevirtual

Initialization function. This function is called once at the beginning of the program. Checks preconditions.

Reimplemented from aspect::Plugins::InterfaceBase.

§ initial_composition()

template<int dim>

double aspect::InitialComposition::SlabModel< dim >::initial_composition	(	const Point< dim > &	position,
		const unsigned int	n_comp
	)		const

overridevirtual

Return the initial composition as a function of position. For the current class, this function returns 1.0 inside subducted slabs and 0.0 outside.

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

§ declare_parameters()

template<int dim>

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

static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>

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

overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

§ get_slab_boundary()

template<int dim>

const Utilities::AsciiDataBoundary<dim>& aspect::InitialComposition::SlabModel< dim >::get_slab_boundary ( ) const

A function that returns the slab_boundary object to allow access in other places.

Member Data Documentation

§ slab_boundary

template<int dim>

Utilities::AsciiDataBoundary<dim> aspect::InitialComposition::SlabModel< dim >::slab_boundary

private

An object of ascii data boundary to input subducted slab depths and thicknesses.

Definition at line 92 of file slab_model.h.

§ surface_boundary_id

template<int dim>

types::boundary_id aspect::InitialComposition::SlabModel< dim >::surface_boundary_id

private

Cache the surface boundary id to avoid unnecessary lookups.

Definition at line 97 of file slab_model.h.

§ slab_index

template<int dim>

unsigned int aspect::InitialComposition::SlabModel< dim >::slab_index

private

Cache the compositional field index that corresponds to the slab composition to avoid unnecessary lookups.

Definition at line 103 of file slab_model.h.

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

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

Member Function Documentation

§ initialize()

§ initial_composition()

§ declare_parameters()

§ parse_parameters()

§ get_slab_boundary()

Member Data Documentation

§ slab_boundary

§ surface_boundary_id

§ slab_index

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