ASPECT
Public Member Functions | Static Public Member Functions | Private Types | Private Attributes | List of all members
aspect::InitialTemperature::LABDepth::LABDepthLookup< dim > Class Template Reference
Inheritance diagram for aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >:
Inheritance graph
[legend]

Public Member Functions

 LABDepthLookup ()
 
void initialize ()
 
double get_lab_depth (const Point< dim > &position) const
 
void parse_parameters (ParameterHandler &prm)
 
- 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::BlockVectorget_current_linearization_point () const
 
const LinearAlgebra::BlockVectorget_solution () const
 
const LinearAlgebra::BlockVectorget_old_solution () const
 
const LinearAlgebra::BlockVectorget_old_old_solution () const
 
const LinearAlgebra::BlockVectorget_reaction_vector () const
 
const LinearAlgebra::BlockVectorget_mesh_velocity () const
 
const DoFHandler< dim > & get_dof_handler () const
 
const FiniteElement< dim > & get_fe () const
 
const LinearAlgebra::BlockSparseMatrixget_system_matrix () const
 
const LinearAlgebra::BlockSparseMatrixget_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
 
const Particle::World< dim > & get_particle_world () const
 
Particle::World< dim > & get_particle_world ()
 
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::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 Types

enum  LABDepthSource { Value, File }
 

Private Attributes

Utilities::StructuredDataLookup< 2 > lab_depths
 
std::string data_directory
 
std::string LAB_file_name
 
LABDepthSource LAB_depth_source
 
double max_depth
 

Detailed Description

template<int dim>
class aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >

Definition at line 39 of file lithosphere_mask.h.

Member Enumeration Documentation

§ LABDepthSource

An enum to describe where the LAB depth is coming from.

Enumerator
Value 
File 

Definition at line 95 of file lithosphere_mask.h.

Constructor & Destructor Documentation

§ LABDepthLookup()

Empty Constructor.

Member Function Documentation

§ initialize()

template<int dim>
void aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >::initialize ( )

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

§ get_lab_depth()

template<int dim>
double aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >::get_lab_depth ( const Point< dim > &  position) const

Return LAB depth as a function of position (latitude and longitude). This function returns either a constant value or values from a text file, depending on the input parameters. Text files are read in two dimensions so the third column (depth) is treated as data.

§ declare_parameters()

template<int dim>
static void aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >::declare_parameters ( ParameterHandler &  prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
void aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >::parse_parameters ( ParameterHandler &  prm)

Read the parameters this class declares from the parameter file.

Member Data Documentation

§ lab_depths

Reads in file containing input data.

Definition at line 80 of file lithosphere_mask.h.

§ data_directory

template<int dim>
std::string aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >::data_directory
private

Directory in which the LAB depth file is present.

Definition at line 85 of file lithosphere_mask.h.

§ LAB_file_name

template<int dim>
std::string aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >::LAB_file_name
private

File name of the LAB depth file.

Definition at line 90 of file lithosphere_mask.h.

§ LAB_depth_source

template<int dim>
LABDepthSource aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >::LAB_depth_source
private

Currently chosen source for the LAB depth.

Definition at line 104 of file lithosphere_mask.h.

§ max_depth

template<int dim>
double aspect::InitialTemperature::LABDepth::LABDepthLookup< dim >::max_depth
private

This parameter gives the maximum depth of the lithosphere. The model returns nans below this depth. This parameter is only used if LAB depth source is set to 'Value'.

Definition at line 111 of file lithosphere_mask.h.


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