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

Public Member Functions

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 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::Plugins::InterfaceBase
virtual ~InterfaceBase ()=default
 
virtual void update ()
 
- 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
 
unsigned int n_particle_managers () const
 
const Particle::Manager< dim > & get_particle_manager (const unsigned int particle_manager_index) const
 
Particle::Manager< dim > & get_particle_manager (const unsigned int particle_manager_index)
 
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
 

Private Attributes

double angle_of_internal_friction
 
double cohesion
 
double min_eta
 
double max_eta
 
double max_lateral_eta_variation
 
double thermal_conductivity_value
 
enum aspect::MaterialModel::EntropyModel::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::string data_directory
 
std::vector< std::string > material_file_names
 
std::string lateral_viscosity_file_name
 
std::vector< std::unique_ptr< MaterialUtilities::Lookup::EntropyReader > > entropy_reader
 
std::unique_ptr< internal::LateralViscosityLookuplateral_viscosity_prefactor_lookup
 
Rheology::DruckerPrager< dim > drucker_prager_plasticity
 
std::unique_ptr< Rheology::AsciiDepthProfile< dim > > depth_dependent_rheology
 

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::Plugins::InterfaceBase
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::EntropyModel< dim >

A material model that is designed to use pressure and entropy (rather than pressure and temperature) as independent variables. It will look up all material properties in a data table for a given pressure and entropy, and will additionally provide an additional output object of type PrescribedTemperatureOutputs filled with the temperature, and an additional output object of type PrescribedFieldOutput filled with the densities (necessary for the projected density approximation of the Stokes equation).

Definition at line 51 of file entropy_model.h.

Member Enumeration Documentation

§ ConductivityFormulation

Enumerator
constant 
p_T_dependent 

Definition at line 136 of file entropy_model.h.

Member Function Documentation

§ initialize()

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

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

Reimplemented from aspect::Plugins::InterfaceBase.

§ is_compressible()

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

Return whether the model is compressible or not.

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

§ evaluate()

template<int dim>
void aspect::MaterialModel::EntropyModel< 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::EntropyModel< dim >::declare_parameters ( ParameterHandler &  prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

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

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

§ create_additional_named_outputs()

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

Creates additional output objects of type PrescribedTemperatureOutputs filled with the temperature (necessary for solving the entropy equation), and an additional output object of type PrescribedFieldOutput filled with the densities (necessary for the projected density approximation of the Stokes equation). Also creates SeismicAdditionalOutputs for postprocessing purposes.

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

§ thermal_conductivity()

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

Member Data Documentation

§ angle_of_internal_friction

template<int dim>
double aspect::MaterialModel::EntropyModel< dim >::angle_of_internal_friction
private

Definition at line 117 of file entropy_model.h.

§ cohesion

template<int dim>
double aspect::MaterialModel::EntropyModel< dim >::cohesion
private

Definition at line 118 of file entropy_model.h.

§ min_eta

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

Minimum/Maximum viscosity and lateral viscosity variations.

Definition at line 123 of file entropy_model.h.

§ max_eta

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

Definition at line 124 of file entropy_model.h.

§ max_lateral_eta_variation

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

Definition at line 125 of file entropy_model.h.

§ thermal_conductivity_value

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

The value for thermal conductivity. It can be a constant for the whole domain, or P-T dependent.

Definition at line 131 of file entropy_model.h.

§ conductivity_formulation

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

§ conductivity_transition_depths

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

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

Definition at line 146 of file entropy_model.h.

§ reference_thermal_conductivities

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

Definition at line 147 of file entropy_model.h.

§ conductivity_pressure_dependencies

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

Definition at line 148 of file entropy_model.h.

§ conductivity_reference_temperatures

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

Definition at line 149 of file entropy_model.h.

§ conductivity_exponents

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

Definition at line 150 of file entropy_model.h.

§ saturation_scaling

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

Definition at line 151 of file entropy_model.h.

§ maximum_conductivity

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

Definition at line 152 of file entropy_model.h.

§ data_directory

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

Information about the location of data files.

Definition at line 157 of file entropy_model.h.

§ material_file_names

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

Definition at line 158 of file entropy_model.h.

§ lateral_viscosity_file_name

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

Definition at line 159 of file entropy_model.h.

§ entropy_reader

template<int dim>
std::vector<std::unique_ptr<MaterialUtilities::Lookup::EntropyReader> > aspect::MaterialModel::EntropyModel< dim >::entropy_reader
private

List of pointers to the EntropyReader that reads in material data for given entropy and pressure. There is one pointer/object per lookup file.

Definition at line 165 of file entropy_model.h.

§ lateral_viscosity_prefactor_lookup

template<int dim>
std::unique_ptr<internal::LateralViscosityLookup> aspect::MaterialModel::EntropyModel< dim >::lateral_viscosity_prefactor_lookup
private

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

Definition at line 171 of file entropy_model.h.

§ drucker_prager_plasticity

template<int dim>
Rheology::DruckerPrager<dim> aspect::MaterialModel::EntropyModel< dim >::drucker_prager_plasticity
private

Objects for computing plastic stresses, viscosities, and additional outputs

Definition at line 176 of file entropy_model.h.

§ depth_dependent_rheology

template<int dim>
std::unique_ptr<Rheology::AsciiDepthProfile<dim> > aspect::MaterialModel::EntropyModel< dim >::depth_dependent_rheology
private

Pointer to the rheology model used for depth-dependence from an ascii file

Definition at line 182 of file entropy_model.h.


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