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

Public Member Functions

void initialize () override
 
void update () 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
 
Physical parameters used in the basic equations
virtual double viscosity (const double temperature, const double pressure, const std::vector< double > &compositional_fields, const SymmetricTensor< 2, dim > &strain_rate, const Point< dim > &position) const
 
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 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 Types

enum  ConductivityFormulation { constant, p_T_dependent }
 

Private Member Functions

double thermal_conductivity (const double temperature, const double pressure, const Point< dim > &position) const
 
void fill_prescribed_outputs (const unsigned int i, const std::vector< double > &volume_fractions, const MaterialModel::MaterialModelInputs< dim > &in, MaterialModel::MaterialModelOutputs< dim > &out) const
 

Private Attributes

bool has_background_field
 
std::unique_ptr< ComponentMask > composition_mask
 
EquationOfState::ThermodynamicTableLookup< dim > equation_of_state
 
bool use_lateral_average_temperature
 
double thermal_conductivity_value
 
enum aspect::MaterialModel::Steinberger::ConductivityFormulation conductivity_formulation
 
std::vector< double > conductivity_transition_depths
 
std::vector< double > reference_thermal_conductivities
 
std::vector< double > conductivity_pressure_dependencies
 
std::vector< double > conductivity_reference_temperatures
 
std::vector< double > conductivity_exponents
 
std::vector< double > saturation_scaling
 
double maximum_conductivity
 
std::vector< double > average_temperature
 
unsigned int n_lateral_slices
 
double min_eta
 
double max_eta
 
double max_lateral_eta_variation
 
std::string data_directory
 
std::string radial_viscosity_file_name
 
std::string lateral_viscosity_file_name
 
std::unique_ptr< internal::LateralViscosityLookuplateral_viscosity_lookup
 
std::unique_ptr< internal::RadialViscosityLookupradial_viscosity_lookup
 

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::Steinberger< dim >

A variable viscosity material model that reads the essential values of coefficients from tables in input files.

The viscosity of this model is based on the paper Steinberger & Calderwood 2006: "Models of large-scale viscous flow in the Earth's mantle with constraints from mineral physics and surface observations". The thermal conductivity is constant and the other parameters are provided via lookup tables from the software PERPLEX.

Definition at line 127 of file steinberger.h.

Member Enumeration Documentation

§ ConductivityFormulation

Enumeration for selecting which type of conductivity law to use.

Enumerator
constant 
p_T_dependent 

Definition at line 261 of file steinberger.h.

Member Function Documentation

§ initialize()

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

Initialization function. Loads the material data and sets up pointers.

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

§ update()

template<int dim>
void aspect::MaterialModel::Steinberger< dim >::update ( )
overridevirtual

Called at the beginning of each time step and allows the material model to update internal data structures.

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

§ viscosity()

template<int dim>
virtual double aspect::MaterialModel::Steinberger< dim >::viscosity ( const double  temperature,
const double  pressure,
const std::vector< double > &  compositional_fields,
const SymmetricTensor< 2, dim > &  strain_rate,
const Point< dim > &  position 
) const
virtual

§ is_compressible()

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

Return whether the model is compressible or not. Incompressibility does not necessarily imply that the density is constant; rather, it may still depend on temperature or pressure. In the current context, compressibility means whether we should solve the continuity equation as \(\nabla \cdot (\rho \mathbf u)=0\) (compressible Stokes) or as \(\nabla \cdot \mathbf{u}=0\) (incompressible Stokes).

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

§ evaluate()

template<int dim>
void aspect::MaterialModel::Steinberger< 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 >.

§ declare_parameters()

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

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
void aspect::MaterialModel::Steinberger< 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::Steinberger< dim >::create_additional_named_outputs ( MaterialModel::MaterialModelOutputs< dim > &  outputs) const
overridevirtual

If this material model can produce additional named outputs that are derived from NamedAdditionalOutputs, create them in here. By default, this does nothing.

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

§ thermal_conductivity()

template<int dim>
double aspect::MaterialModel::Steinberger< dim >::thermal_conductivity ( const double  temperature,
const double  pressure,
const Point< dim > &  position 
) const
private

Compute the pressure- and temperature-dependent thermal conductivity either as a constant value, or based on the equation given in Stackhouse et al., 2015: First-principles calculations of the lattice thermal conductivity of the lower mantle, or based on the equation given in Tosi et al., 2013: Mantle dynamics with pressure- and temperature-dependent thermal expansivity and conductivity.

§ fill_prescribed_outputs()

template<int dim>
void aspect::MaterialModel::Steinberger< dim >::fill_prescribed_outputs ( const unsigned int  i,
const std::vector< double > &  volume_fractions,
const MaterialModel::MaterialModelInputs< dim > &  in,
MaterialModel::MaterialModelOutputs< dim > &  out 
) const
private

A function that fills the prescribed additional outputs in the MaterialModelOutputs object that is handed over, if it exists, in this case, densities for the projected density approximation. Does nothing otherwise.

Member Data Documentation

§ has_background_field

template<int dim>
bool aspect::MaterialModel::Steinberger< dim >::has_background_field
private

Whether the compositional fields representing mass fractions should be normalized to one when computing their fractions (if false), or whether there is an additional composition (the background field) that is not represented by a compositional field, and makes up the remaining fraction of material if the compositional fields add up to less than one at any given location (if true).

Definition at line 229 of file steinberger.h.

§ composition_mask

template<int dim>
std::unique_ptr<ComponentMask> aspect::MaterialModel::Steinberger< dim >::composition_mask
private

Pointer to a composition mask, which is meant to be filled with one entry per compositional field that determines if this field is considered to represent a mass fractions (if the entry is set to true) or not (if set to false). This is needed for averaging of material properties.

Definition at line 238 of file steinberger.h.

§ equation_of_state

template<int dim>
EquationOfState::ThermodynamicTableLookup<dim> aspect::MaterialModel::Steinberger< dim >::equation_of_state
private

The thermodynamic lookup equation of state.

Definition at line 243 of file steinberger.h.

§ use_lateral_average_temperature

template<int dim>
bool aspect::MaterialModel::Steinberger< dim >::use_lateral_average_temperature
private

Boolean describing whether to use the lateral average temperature for computing the viscosity, rather than the temperature on the reference adiabat.

Definition at line 250 of file steinberger.h.

§ thermal_conductivity_value

template<int dim>
double aspect::MaterialModel::Steinberger< dim >::thermal_conductivity_value
private

The value of the thermal conductivity if a constant thermal conductivity is used for the whole domain.

Definition at line 256 of file steinberger.h.

§ conductivity_formulation

template<int dim>
enum aspect::MaterialModel::Steinberger::ConductivityFormulation aspect::MaterialModel::Steinberger< dim >::conductivity_formulation
private

§ conductivity_transition_depths

template<int dim>
std::vector<double> aspect::MaterialModel::Steinberger< dim >::conductivity_transition_depths
private

Parameters for the temperature- and pressure dependence of the thermal conductivity.

Definition at line 271 of file steinberger.h.

§ reference_thermal_conductivities

template<int dim>
std::vector<double> aspect::MaterialModel::Steinberger< dim >::reference_thermal_conductivities
private

Definition at line 272 of file steinberger.h.

§ conductivity_pressure_dependencies

template<int dim>
std::vector<double> aspect::MaterialModel::Steinberger< dim >::conductivity_pressure_dependencies
private

Definition at line 273 of file steinberger.h.

§ conductivity_reference_temperatures

template<int dim>
std::vector<double> aspect::MaterialModel::Steinberger< dim >::conductivity_reference_temperatures
private

Definition at line 274 of file steinberger.h.

§ conductivity_exponents

template<int dim>
std::vector<double> aspect::MaterialModel::Steinberger< dim >::conductivity_exponents
private

Definition at line 275 of file steinberger.h.

§ saturation_scaling

template<int dim>
std::vector<double> aspect::MaterialModel::Steinberger< dim >::saturation_scaling
private

Definition at line 276 of file steinberger.h.

§ maximum_conductivity

template<int dim>
double aspect::MaterialModel::Steinberger< dim >::maximum_conductivity
private

Definition at line 277 of file steinberger.h.

§ average_temperature

template<int dim>
std::vector<double> aspect::MaterialModel::Steinberger< dim >::average_temperature
private

Information about lateral temperature averages.

Definition at line 282 of file steinberger.h.

§ n_lateral_slices

template<int dim>
unsigned int aspect::MaterialModel::Steinberger< dim >::n_lateral_slices
private

Definition at line 283 of file steinberger.h.

§ min_eta

template<int dim>
double aspect::MaterialModel::Steinberger< dim >::min_eta
private

Minimum and maximum allowed viscosity, as well as the maximum allowed viscosity variation compared to the average radial viscosity.

Definition at line 289 of file steinberger.h.

§ max_eta

template<int dim>
double aspect::MaterialModel::Steinberger< dim >::max_eta
private

Definition at line 290 of file steinberger.h.

§ max_lateral_eta_variation

template<int dim>
double aspect::MaterialModel::Steinberger< dim >::max_lateral_eta_variation
private

Definition at line 291 of file steinberger.h.

§ data_directory

template<int dim>
std::string aspect::MaterialModel::Steinberger< dim >::data_directory
private

Information about the location of data files.

Definition at line 296 of file steinberger.h.

§ radial_viscosity_file_name

template<int dim>
std::string aspect::MaterialModel::Steinberger< dim >::radial_viscosity_file_name
private

Definition at line 297 of file steinberger.h.

§ lateral_viscosity_file_name

template<int dim>
std::string aspect::MaterialModel::Steinberger< dim >::lateral_viscosity_file_name
private

Definition at line 298 of file steinberger.h.

§ lateral_viscosity_lookup

template<int dim>
std::unique_ptr<internal::LateralViscosityLookup> aspect::MaterialModel::Steinberger< dim >::lateral_viscosity_lookup
private

Pointer to an object that reads and processes data for the lateral temperature dependency of viscosity.

Definition at line 304 of file steinberger.h.

§ radial_viscosity_lookup

template<int dim>
std::unique_ptr<internal::RadialViscosityLookup> aspect::MaterialModel::Steinberger< dim >::radial_viscosity_lookup
private

Pointer to an object that reads and processes data for the radial viscosity profile.

Definition at line 310 of file steinberger.h.


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