Inheritance diagram for aspect::InitialTemperature::PatchOnS40RTS< dim >:

[legend]

Public Member Functions
	PatchOnS40RTS ()

void	initialize () override

double	ascii_grid_vs (const Point< dim > &position) const

double	initial_temperature (const Point< dim > &position) const override

void	parse_parameters (ParameterHandler &prm) override

Public Member Functions inherited from aspect::Utilities::AsciiDataInitial< dim >
	AsciiDataInitial ()

virtual void	initialize (const unsigned int components)

double	get_data_component (const Point< dim > &position, const unsigned int component) const

void	parse_parameters (ParameterHandler &prm, const std::string &subsection_name="Ascii data model")

Public Member Functions inherited from aspect::Utilities::AsciiDataBase< dim >
	AsciiDataBase ()

void	parse_parameters (ParameterHandler &prm, const std::string &subsection_name="Ascii data model")

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

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

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)

Static Public Member Functions
static void	declare_parameters (ParameterHandler &prm)

Static Public Member Functions inherited from aspect::Utilities::AsciiDataInitial< dim >
static void	declare_parameters (ParameterHandler &prm, const std::string &default_directory, const std::string &default_filename, const std::string &subsection_name="Ascii data model")

Static Public Member Functions inherited from aspect::Utilities::AsciiDataBase< dim >
static void	declare_parameters (ParameterHandler &prm, const std::string &default_directory, const std::string &default_filename, const std::string &subsection_name="Ascii data model")

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)

Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void	declare_parameters (ParameterHandler &prm)

Public Attributes
double	max_grid_depth

double	smoothing_length_scale

Public Attributes inherited from aspect::Utilities::AsciiDataBase< dim >
std::string	data_directory

std::string	data_file_name

double	scale_factor

Private Attributes
S40RTSPerturbation< dim >	s40rts

double	no_perturbation_depth_patch

Additional Inherited Members
Protected Attributes inherited from aspect::Utilities::AsciiDataInitial< dim >
std::unique_ptr< aspect::Utilities::StructuredDataLookup< dim > >	lookup

std::unique_ptr< aspect::Utilities::StructuredDataLookup< 3 > >	slice_lookup

bool	slice_data

Tensor< 2, 3 >	rotation_matrix

Detailed Description

template<int dim>
class aspect::InitialTemperature::PatchOnS40RTS< dim >

A class that implements a prescribed temperature field determined from an upper mantle Vs model (input as an ascii file) above a specified depth and S40RTS below the specified depth.

Definition at line 43 of file patch_on_S40RTS.h.

Constructor & Destructor Documentation

◆ PatchOnS40RTS()

template<int dim>

aspect::InitialTemperature::PatchOnS40RTS< dim >::PatchOnS40RTS ( )

Empty Constructor.

Member Function Documentation

◆ initialize()

template<int dim>

void aspect::InitialTemperature::PatchOnS40RTS< dim >::initialize ( )

overridevirtual

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

Reimplemented from aspect::Plugins::InterfaceBase.

◆ ascii_grid_vs()

template<int dim>

double aspect::InitialTemperature::PatchOnS40RTS< dim >::ascii_grid_vs ( const Point< dim > & position ) const

Return Vs as a function of position. For the current class, this function returns value from the text files.

◆ initial_temperature()

template<int dim>

double aspect::InitialTemperature::PatchOnS40RTS< dim >::initial_temperature ( const Point< dim > & position ) const

overridevirtual

Return the initial temperature as a function of position. For the current class, this function calculates temperature from ascii grid Vs data above max_grid_depth and S40RTS Vs data below max_grid_depth.

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

◆ declare_parameters()

template<int dim>

static void aspect::InitialTemperature::PatchOnS40RTS< dim >::declare_parameters ( ParameterHandler & prm )

static

Declare the parameters this class takes through input files.

◆ parse_parameters()

template<int dim>

void aspect::InitialTemperature::PatchOnS40RTS< dim >::parse_parameters ( ParameterHandler & prm )

overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

◆ max_grid_depth

template<int dim>

double aspect::InitialTemperature::PatchOnS40RTS< dim >::max_grid_depth

This parameter gives the maximum depth of the Vs ascii grid. The model will read in Vs from S40RTS below this depth.

This variable is read from the parameter file through a parameter called 'Maximum grid depth'.

Definition at line 74 of file patch_on_S40RTS.h.

◆ smoothing_length_scale

template<int dim>

double aspect::InitialTemperature::PatchOnS40RTS< dim >::smoothing_length_scale

This parameter gives the range (above maximum grid depth) over which to smooth. Smoothing is done with a depth weighted combination of the values in the ascii grid and S40RTS at each point. This variable is read from the parameter file through a parameter called 'Smoothing length scale'.

Definition at line 82 of file patch_on_S40RTS.h.

◆ s40rts

template<int dim>

S40RTSPerturbation<dim> aspect::InitialTemperature::PatchOnS40RTS< dim >::s40rts

private

Declare a member variable of type S40RTSPerturbation that allows us to call functions from S40RTS_perturbation.cc.

Definition at line 110 of file patch_on_S40RTS.h.

◆ no_perturbation_depth_patch

template<int dim>

double aspect::InitialTemperature::PatchOnS40RTS< dim >::no_perturbation_depth_patch

private

This parameter is the depth down to which shear wave perturbations are zeroed out.

This variable is read from the parameter file through a parameter called 'Remove temperature heterogeneity down to specified depth'.

Definition at line 118 of file patch_on_S40RTS.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/latest/include/aspect/initial_temperature/S40RTS_perturbation.h
/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/latest/include/aspect/initial_temperature/patch_on_S40RTS.h

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

template<int dim> class aspect::InitialTemperature::PatchOnS40RTS< dim >

Constructor & Destructor Documentation

◆ PatchOnS40RTS()

Member Function Documentation

◆ initialize()

◆ ascii_grid_vs()

◆ initial_temperature()

◆ declare_parameters()

◆ parse_parameters()

Member Data Documentation

◆ max_grid_depth

◆ smoothing_length_scale

◆ s40rts

◆ no_perturbation_depth_patch

template<int dim>
class aspect::InitialTemperature::PatchOnS40RTS< dim >