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

virtual void initialize ()
 
virtual void update ()
 
virtual void evaluate (const MaterialModel::MaterialModelInputs< dim > &in, MaterialModel::MaterialModelOutputs< dim > &out) const
 
virtual void create_additional_named_outputs (MaterialModel::MaterialModelOutputs< dim > &out) const
 
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
 
virtual double density (const double temperature, const double pressure, const std::vector< double > &compositional_fields, const Point< dim > &position) const
 
virtual double compressibility (const double temperature, const double pressure, const std::vector< double > &compositional_fields, const Point< dim > &position) const
 
virtual double specific_heat (const double temperature, const double pressure, const std::vector< double > &compositional_fields, const Point< dim > &position) const
 
virtual double thermal_conductivity (const double temperature, const double pressure, const std::vector< double > &compositional_fields, const Point< dim > &position) const
 
virtual double thermal_expansion_coefficient (const double temperature, const double pressure, const std::vector< double > &compositional_fields, const Point< dim > &position) const
 
virtual double seismic_Vp (const double temperature, const double pressure, const std::vector< double > &compositional_fields, const Point< dim > &position) const
 
virtual double seismic_Vs (const double temperature, const double pressure, const std::vector< double > &compositional_fields, const Point< dim > &position) const
 
std::array< std::pair< double, unsigned int >, 2 > enthalpy_derivative (const typename Interface< dim >::MaterialModelInputs &in) const
 
Qualitative properties one can ask a material model
virtual bool is_compressible () const
 
Reference quantities
virtual double reference_viscosity () const
 
- 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_free_surface_boundary_indicators () const
 
DEAL_II_DEPRECATED const std::map< types::boundary_id, std::shared_ptr< BoundaryVelocity::Interface< dim > > > get_prescribed_boundary_velocity () 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 WorldBuilder::World & get_world_builder () const
 
const FreeSurfaceHandler< dim > & get_free_surface_handler () const
 
const LateralAveraging< dim > & get_lateral_averaging () const
 
const ConstraintMatrix & get_current_constraints () const
 
bool simulator_is_initialized () 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
 

Private Attributes

bool interpolation
 
bool latent_heat
 
bool use_lateral_average_temperature
 
double reference_eta
 
double thermal_conductivity_value
 
std::vector< double > avg_temp
 
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::shared_ptr< Lookup::PerplexReader > > material_lookup
 
std::shared_ptr< internal::LateralViscosityLookuplateral_viscosity_lookup
 
std::shared_ptr< internal::RadialViscosityLookupradial_viscosity_lookup
 

Functions used in dealing with run-time parameters

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

Additional Inherited Members

- Public Types inherited from aspect::MaterialModel::Interface< dim >
typedef MaterialModel::MaterialModelInputs< dim > MaterialModelInputs
 
typedef MaterialModel::MaterialModelOutputs< dim > MaterialModelOutputs
 
- 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 126 of file steinberger.h.

Member Function Documentation

§ initialize()

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

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

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

§ update()

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

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

§ density()

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

§ compressibility()

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

§ specific_heat()

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

§ thermal_conductivity()

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

§ thermal_expansion_coefficient()

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

§ seismic_Vp()

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

§ seismic_Vs()

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

§ enthalpy_derivative()

template<int dim>
std::array<std::pair<double, unsigned int>,2> aspect::MaterialModel::Steinberger< dim >::enthalpy_derivative ( 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>
virtual bool aspect::MaterialModel::Steinberger< dim >::is_compressible ( ) const
virtual

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>
virtual double aspect::MaterialModel::Steinberger< dim >::reference_viscosity ( ) const
virtual

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>
virtual void aspect::MaterialModel::Steinberger< dim >::evaluate ( const MaterialModel::MaterialModelInputs< dim > &  in,
MaterialModel::MaterialModelOutputs< dim > &  out 
) const
virtual

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>
virtual void aspect::MaterialModel::Steinberger< dim >::parse_parameters ( ParameterHandler prm)
virtual

Read the parameters this class declares from the parameter file.

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

§ create_additional_named_outputs()

template<int dim>
virtual void aspect::MaterialModel::Steinberger< dim >::create_additional_named_outputs ( MaterialModel::MaterialModelOutputs< dim > &  outputs) const
virtual

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

§ interpolation

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

Definition at line 269 of file steinberger.h.

§ latent_heat

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

Definition at line 270 of file steinberger.h.

§ use_lateral_average_temperature

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

Definition at line 271 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 277 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 283 of file steinberger.h.

§ avg_temp

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

Information about lateral temperature averages.

Definition at line 288 of file steinberger.h.

§ n_lateral_slices

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

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

§ max_eta

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

Definition at line 296 of file steinberger.h.

§ max_lateral_eta_variation

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

Definition at line 297 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 302 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 303 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 304 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 305 of file steinberger.h.

§ material_lookup

template<int dim>
std::vector<std::shared_ptr<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 311 of file steinberger.h.

§ lateral_viscosity_lookup

template<int dim>
std::shared_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::shared_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: