ASPECT
Public 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
 
void fill_mass_and_volume_fractions (const MaterialModel::MaterialModelInputs< dim > &in, std::vector< std::vector< double >> &mass_fractions, std::vector< std::vector< double >> &volume_fractions) const
 
void fill_seismic_velocities (const MaterialModel::MaterialModelInputs< dim > &in, const std::vector< double > &composite_densities, const std::vector< std::vector< double >> &volume_fractions, SeismicAdditionalOutputs< dim > *seismic_out) const
 
void fill_phase_volume_fractions (const MaterialModel::MaterialModelInputs< dim > &in, const std::vector< std::vector< double >> &volume_fractions, NamedAdditionalMaterialOutputs< dim > *phase_volume_fractions_out) const
 
std::array< std::pair< double, unsigned int >, 2 > enthalpy_derivatives (const typename Interface< dim >::MaterialModelInputs &in) const
 
Qualitative properties one can ask a material model
bool is_compressible () const override
 
Reference quantities
double reference_viscosity () const override
 
- Public Member Functions inherited from aspect::MaterialModel::Interface< dim >
virtual ~Interface ()
 
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 ()
 
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
 
TimerOutputget_computing_timer () const
 
const ConditionalOStreamget_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
 
void compute_material_model_input_values (const LinearAlgebra::BlockVector &input_solution, const FEValuesBase< dim, dim > &input_finite_element_values, const typename DoFHandler< dim >::active_cell_iterator &cell, const bool compute_strainrate, MaterialModel::MaterialModelInputs< dim > &material_model_inputs) 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
 
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
 
DEAL_II_DEPRECATED const InitialComposition::Interface< dim > & get_initial_composition () 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
 
TableHandlerget_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 has_background
 
unsigned int first_composition_index
 
bool interpolation
 
bool latent_heat
 
bool use_lateral_average_temperature
 
double reference_eta
 
double thermal_conductivity_value
 
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::vector< std::string > material_file_names
 
std::string radial_viscosity_file_name
 
std::string lateral_viscosity_file_name
 
std::vector< std::unique_ptr< MaterialModel::MaterialUtilities::Lookup::PerplexReader > > material_lookup
 
std::vector< std::string > unique_phase_names
 
std::vector< std::vector< unsigned int > > unique_phase_indices
 
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 125 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

§ fill_mass_and_volume_fractions()

template<int dim>
void aspect::MaterialModel::Steinberger< dim >::fill_mass_and_volume_fractions ( const MaterialModel::MaterialModelInputs< dim > &  in,
std::vector< std::vector< double >> &  mass_fractions,
std::vector< std::vector< double >> &  volume_fractions 
) const

§ fill_seismic_velocities()

template<int dim>
void aspect::MaterialModel::Steinberger< dim >::fill_seismic_velocities ( const MaterialModel::MaterialModelInputs< dim > &  in,
const std::vector< double > &  composite_densities,
const std::vector< std::vector< double >> &  volume_fractions,
SeismicAdditionalOutputs< dim > *  seismic_out 
) const

§ fill_phase_volume_fractions()

template<int dim>
void aspect::MaterialModel::Steinberger< dim >::fill_phase_volume_fractions ( const MaterialModel::MaterialModelInputs< dim > &  in,
const std::vector< std::vector< double >> &  volume_fractions,
NamedAdditionalMaterialOutputs< dim > *  phase_volume_fractions_out 
) const

This function uses the MaterialModelInputs &in to fill the output_values of the phase_volume_fractions_out output object with the volume fractions of each of the unique phases at each of the evaluation points. These volume fractions are obtained from the PerpleX-derived pressure-temperature lookup tables. The filled output_values object is a vector of vector<double>; the outer vector is expected to have a size that equals the number of unique phases, the inner vector is expected to have a size that equals the number of evaluation points.

§ enthalpy_derivatives()

template<int dim>
std::array<std::pair<double, unsigned int>,2> aspect::MaterialModel::Steinberger< dim >::enthalpy_derivatives ( const typename Interface< dim >::MaterialModelInputs in) const

Returns the cell-wise averaged enthalpy derivatives for the evaluate function and postprocessors. The function returns two pairs, the first one represents the temperature derivative, the second one the pressure derivative. The first member of each pair is the derivative, the second one the number of vertex combinations the function could use to compute the derivative. The second member is useful to handle the case no suitable combination of vertices could be found (e.g. if the temperature and pressure on all vertices of the current cell is identical.

§ 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 >.

§ reference_viscosity()

template<int dim>
double aspect::MaterialModel::Steinberger< dim >::reference_viscosity ( ) const
overridevirtual

Return a reference value typical of the viscosities that appear in this model. This value is not actually used in the material description itself, but is used in scaling variables to the same numerical order of magnitude when solving linear systems. Specifically, the reference viscosity appears in the factor scaling the pressure against the velocity. It is also used in computing dimension-less quantities. You may want to take a look at the Kronbichler, Heister, Bangerth 2012 paper that describes the design of ASPECT for a description of this pressure scaling.

Note
The reference viscosity should take into account the complete constitutive relationship, defined as the scalar viscosity times the constitutive tensor. In most cases, the constitutive tensor will simply be the identity tensor (this is the default case), but this may become important for material models with anisotropic viscosities, if the constitutive tensor is not normalized.

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. If MaterialModelInputs.strain_rate has the length 0, then the viscosity does not need to be computed.

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 >.

Member Data Documentation

§ has_background

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

Definition at line 253 of file steinberger.h.

§ first_composition_index

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

Definition at line 254 of file steinberger.h.

§ interpolation

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

Definition at line 256 of file steinberger.h.

§ latent_heat

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

Definition at line 257 of file steinberger.h.

§ use_lateral_average_temperature

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

Definition at line 258 of file steinberger.h.

§ reference_eta

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

Reference viscosity. Only used for pressure scaling purposes and returned by the reference_viscosity() function.

Definition at line 264 of file steinberger.h.

§ thermal_conductivity_value

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

The value for thermal conductivity. This model only implements a constant thermal conductivity for the whole domain.

Definition at line 270 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 275 of file steinberger.h.

§ n_lateral_slices

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

Definition at line 276 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 282 of file steinberger.h.

§ max_eta

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

Definition at line 283 of file steinberger.h.

§ max_lateral_eta_variation

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

Definition at line 284 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 289 of file steinberger.h.

§ material_file_names

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

Definition at line 290 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 291 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 292 of file steinberger.h.

§ material_lookup

template<int dim>
std::vector<std::unique_ptr<MaterialModel::MaterialUtilities::Lookup::PerplexReader> > aspect::MaterialModel::Steinberger< dim >::material_lookup
private

List of pointers to objects that read and process data we get from Perplex files.

Definition at line 298 of file steinberger.h.

§ unique_phase_names

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

Vector of strings containing the names of the unique phases in all the material lookups.

Definition at line 303 of file steinberger.h.

§ unique_phase_indices

template<int dim>
std::vector<std::vector<unsigned int> > aspect::MaterialModel::Steinberger< dim >::unique_phase_indices
private

Vector of vector of unsigned ints which constitutes mappings between lookup phase name vectors and unique_phase_names. The element unique_phase_indices[i][j] contains the index of phase name j from lookup i as it is found in unique_phase_names.

Definition at line 311 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 317 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 323 of file steinberger.h.


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