ASPECT
Public Member Functions | Private Attributes | List of all members
aspect::MaterialModel::AsciiReferenceProfile< dim > Class Template Reference
Inheritance diagram for aspect::MaterialModel::AsciiReferenceProfile< dim >:
Inheritance graph
[legend]

Public Member Functions

 AsciiReferenceProfile ()
 
void initialize () override
 
void evaluate (const MaterialModel::MaterialModelInputs< dim > &in, MaterialModel::MaterialModelOutputs< dim > &out) const override
 
void create_additional_named_outputs (MaterialModel::MaterialModelOutputs< dim > &out) const override
 
Qualitative properties one can ask a material model
bool is_compressible () const override
 
- Public Member Functions inherited from aspect::MaterialModel::Interface< dim >
virtual ~Interface ()=default
 
virtual void update ()
 
virtual void fill_additional_material_model_inputs (MaterialModel::MaterialModelInputs< dim > &input, const LinearAlgebra::BlockVector &solution, const FEValuesBase< dim > &fe_values, const Introspection< dim > &introspection) const
 
const NonlinearDependence::ModelDependenceget_model_dependence () const
 
- 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)
 
template<typename PostprocessorType >
PostprocessorType * find_postprocessor () const
 
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
 
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
 
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
 
DEAL_II_DEPRECATED const BoundaryTemperature::Interface< dim > & get_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
 
DEAL_II_DEPRECATED const BoundaryComposition::Interface< dim > & get_boundary_composition () const
 
const BoundaryComposition::Manager< dim > & get_boundary_composition_manager () const
 
const std::map< types::boundary_id, std::unique_ptr< BoundaryTraction::Interface< dim > > > & get_boundary_traction () const
 
DEAL_II_DEPRECATED const InitialTemperature::Interface< dim > & get_initial_temperature () const
 
std::shared_ptr< const InitialTemperature::Manager< dim > > get_initial_temperature_manager_pointer () const
 
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
 
DEAL_II_DEPRECATED const InitialComposition::Interface< dim > & get_initial_composition () 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
 
template<typename PostprocessorType >
DEAL_II_DEPRECATED PostprocessorType * find_postprocessor () 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
 

Private Attributes

bool tala
 
double viscosity
 
double thermal_viscosity_exponent
 
std::vector< double > viscosity_prefactors
 
std::vector< double > transition_depths
 
double thermal_conductivity
 
aspect::Utilities::AsciiDataProfile< dim > profile
 
unsigned int density_index
 
unsigned int thermal_expansivity_index
 
unsigned int specific_heat_index
 
unsigned int compressibility_index
 
unsigned int seismic_vp_index
 
unsigned int seismic_vs_index
 
unsigned int seismic_dvp_dT_index
 
unsigned int seismic_dvs_dT_index
 

Functions used in dealing with run-time parameters

void parse_parameters (ParameterHandler &prm) override
 
static void declare_parameters (ParameterHandler &prm)
 

Additional Inherited Members

- Public Types inherited from aspect::MaterialModel::Interface< dim >
using MaterialModelInputs = MaterialModel::MaterialModelInputs< dim >
 
using MaterialModelOutputs = MaterialModel::MaterialModelOutputs< dim >
 
- Static Public Member Functions inherited from aspect::MaterialModel::Interface< dim >
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)
 
- Protected Attributes inherited from aspect::MaterialModel::Interface< dim >
NonlinearDependence::ModelDependence model_dependence
 

Detailed Description

template<int dim>
class aspect::MaterialModel::AsciiReferenceProfile< dim >

A material model that reads in a reference profile from an ascii file and computes properties based on this profile.

The viscosity is computed as

\[ \eta(z,T) = \eta_r(z) \eta_0 \exp\left(-A \frac{T - T_\text{adi}}{T_\text{adi}}\right)." \]

Definition at line 46 of file ascii_reference_profile.h.

Constructor & Destructor Documentation

§ AsciiReferenceProfile()

Constructor. Initialize variables.

Member Function Documentation

§ initialize()

template<int dim>
void aspect::MaterialModel::AsciiReferenceProfile< dim >::initialize ( )
overridevirtual

Initialization function. This function is called once at the beginning of the program after parse_parameters is run and after the SimulatorAccess (if applicable) is initialized.

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

§ evaluate()

template<int dim>
void aspect::MaterialModel::AsciiReferenceProfile< dim >::evaluate ( const MaterialModel::MaterialModelInputs< dim > &  in,
MaterialModel::MaterialModelOutputs< dim > &  out 
) const
overridevirtual

Function to compute the material properties in out given the inputs in in.

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

§ is_compressible()

template<int dim>
bool aspect::MaterialModel::AsciiReferenceProfile< dim >::is_compressible ( ) const
overridevirtual

Return whether the model is compressible or not.

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

§ declare_parameters()

template<int dim>
static void aspect::MaterialModel::AsciiReferenceProfile< dim >::declare_parameters ( ParameterHandler &  prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
void aspect::MaterialModel::AsciiReferenceProfile< dim >::parse_parameters ( ParameterHandler &  prm)
overridevirtual

Read the parameters this class declares from the parameter file.

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

§ create_additional_named_outputs()

template<int dim>
void aspect::MaterialModel::AsciiReferenceProfile< dim >::create_additional_named_outputs ( MaterialModel::MaterialModelOutputs< dim > &  out) const
overridevirtual

Add the named outputs for seismic velocities.

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

Member Data Documentation

§ tala

template<int dim>
bool aspect::MaterialModel::AsciiReferenceProfile< dim >::tala
private

Use truncated anelastic approximation?

Definition at line 110 of file ascii_reference_profile.h.

§ viscosity

template<int dim>
double aspect::MaterialModel::AsciiReferenceProfile< dim >::viscosity
private

The reference viscosity

Definition at line 115 of file ascii_reference_profile.h.

§ thermal_viscosity_exponent

template<int dim>
double aspect::MaterialModel::AsciiReferenceProfile< dim >::thermal_viscosity_exponent
private

The constant \(A\) in the temperature dependence of viscosity \(\exp\left(-A \frac{T - T_\text{adi}}{T_\text{adi}}\right).\)

Definition at line 121 of file ascii_reference_profile.h.

§ viscosity_prefactors

template<int dim>
std::vector<double> aspect::MaterialModel::AsciiReferenceProfile< dim >::viscosity_prefactors
private

A list of constants that make up the piece-wise constant function \(\eta_r(z)\), which determines the depth dependence of viscosity, and is multiplied with the reference viscosity and the temperature dependence to compute the viscosity \(\eta(z,T)\).

Definition at line 129 of file ascii_reference_profile.h.

§ transition_depths

template<int dim>
std::vector<double> aspect::MaterialModel::AsciiReferenceProfile< dim >::transition_depths
private

A list of depths that determine the locations of the jumps in the piece-wise constant function \(\eta_r(z)\), which describes the depth dependence of viscosity.

Definition at line 136 of file ascii_reference_profile.h.

§ thermal_conductivity

template<int dim>
double aspect::MaterialModel::AsciiReferenceProfile< dim >::thermal_conductivity
private

Definition at line 138 of file ascii_reference_profile.h.

§ profile

Object containing the data profile.

Definition at line 143 of file ascii_reference_profile.h.

§ density_index

template<int dim>
unsigned int aspect::MaterialModel::AsciiReferenceProfile< dim >::density_index
private

The column indices of the temperature, pressure, and density column in the data file.

Definition at line 149 of file ascii_reference_profile.h.

§ thermal_expansivity_index

template<int dim>
unsigned int aspect::MaterialModel::AsciiReferenceProfile< dim >::thermal_expansivity_index
private

Definition at line 150 of file ascii_reference_profile.h.

§ specific_heat_index

template<int dim>
unsigned int aspect::MaterialModel::AsciiReferenceProfile< dim >::specific_heat_index
private

Definition at line 151 of file ascii_reference_profile.h.

§ compressibility_index

template<int dim>
unsigned int aspect::MaterialModel::AsciiReferenceProfile< dim >::compressibility_index
private

Definition at line 152 of file ascii_reference_profile.h.

§ seismic_vp_index

template<int dim>
unsigned int aspect::MaterialModel::AsciiReferenceProfile< dim >::seismic_vp_index
private

The column indices of the seismic velocities and their temperature derivatives columns in the data file.

Definition at line 158 of file ascii_reference_profile.h.

§ seismic_vs_index

template<int dim>
unsigned int aspect::MaterialModel::AsciiReferenceProfile< dim >::seismic_vs_index
private

Definition at line 159 of file ascii_reference_profile.h.

§ seismic_dvp_dT_index

template<int dim>
unsigned int aspect::MaterialModel::AsciiReferenceProfile< dim >::seismic_dvp_dT_index
private

Definition at line 160 of file ascii_reference_profile.h.

§ seismic_dvs_dT_index

template<int dim>
unsigned int aspect::MaterialModel::AsciiReferenceProfile< dim >::seismic_dvs_dT_index
private

Definition at line 161 of file ascii_reference_profile.h.


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