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

Public Member Functions

virtual bool is_compressible () const
 
virtual void evaluate (const typename Interface< dim >::MaterialModelInputs &in, typename Interface< dim >::MaterialModelOutputs &out) const
 
virtual void melt_fractions (const MaterialModel::MaterialModelInputs< dim > &in, std::vector< double > &melt_fractions) const
 
virtual void create_additional_named_outputs (MaterialModel::MaterialModelOutputs< dim > &out) const
 
Reference quantities
virtual double reference_viscosity () const
 
virtual double reference_darcy_coefficient () const
 
- Public Member Functions inherited from aspect::MaterialModel::MeltInterface< dim >
double p_c_scale (const MaterialModel::MaterialModelInputs< dim > &inputs, const MaterialModel::MaterialModelOutputs< dim > &outputs, const MeltHandler< dim > &handler, const bool consider_is_melt_cell) const
 
- Public Member Functions inherited from aspect::MaterialModel::Interface< dim >
virtual ~Interface ()
 
virtual void initialize ()
 
virtual void update ()
 
virtual void evaluate (const MaterialModel::MaterialModelInputs< dim > &in, MaterialModel::MaterialModelOutputs< dim > &out) const =0
 
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
 
- Public Member Functions inherited from aspect::MaterialModel::MeltFractionModel< dim >
virtual ~MeltFractionModel ()
 

Private Member Functions

virtual double melt_fraction (const double temperature, const double pressure, const double depletion) const
 

Private Attributes

double reference_rho_s
 
double reference_rho_f
 
double reference_T
 
double eta_0
 
double xi_0
 
double eta_f
 
double thermal_viscosity_exponent
 
double thermal_bulk_viscosity_exponent
 
double thermal_expansivity
 
double reference_specific_heat
 
double thermal_conductivity
 
double reference_permeability
 
double alpha_phi
 
double depletion_density_change
 
double depletion_solidus_change
 
double pressure_solidus_change
 
double surface_solidus
 
double compressibility
 
double melt_compressibility
 
bool include_melting_and_freezing
 
double melting_time_scale
 
double alpha_depletion
 
double delta_eta_depletion_max
 
double peridotite_melting_entropy_change
 

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

A material model that implements a simple formulation of the material parameters required for the modelling of melt transport in a global model, including a source term for the porosity according a simplified linear melting model.

The model is considered incompressible, following the definition described in Interface::is_compressible.

Definition at line 47 of file melt_global.h.

Member Function Documentation

§ is_compressible()

template<int dim>
virtual bool aspect::MaterialModel::MeltGlobal< 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 >.

§ evaluate()

template<int dim>
virtual void aspect::MaterialModel::MeltGlobal< dim >::evaluate ( const typename Interface< dim >::MaterialModelInputs in,
typename Interface< dim >::MaterialModelOutputs out 
) const
virtual

§ melt_fractions()

template<int dim>
virtual void aspect::MaterialModel::MeltGlobal< dim >::melt_fractions ( const MaterialModel::MaterialModelInputs< dim > &  in,
std::vector< double > &  melt_fractions 
) const
virtual

Compute the equilibrium melt fractions for the given input conditions. in and melt_fractions need to have the same size.

Parameters
inObject that contains the current conditions.
melt_fractionsVector of doubles that is filled with the equilibrium melt fraction for each given input conditions.

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

§ reference_viscosity()

template<int dim>
virtual double aspect::MaterialModel::MeltGlobal< 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 >.

§ reference_darcy_coefficient()

template<int dim>
virtual double aspect::MaterialModel::MeltGlobal< dim >::reference_darcy_coefficient ( ) const
virtual

Reference value for the Darcy coefficient, which is defined as permeability divided by fluid viscosity. Units: m^2/Pa/s.

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

§ declare_parameters()

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

Declare the parameters this class takes through input files.

§ parse_parameters()

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

§ melt_fraction()

template<int dim>
virtual double aspect::MaterialModel::MeltGlobal< dim >::melt_fraction ( const double  temperature,
const double  pressure,
const double  depletion 
) const
privatevirtual

Member Data Documentation

§ reference_rho_s

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::reference_rho_s
private

Definition at line 114 of file melt_global.h.

§ reference_rho_f

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::reference_rho_f
private

Definition at line 115 of file melt_global.h.

§ reference_T

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::reference_T
private

Definition at line 116 of file melt_global.h.

§ eta_0

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::eta_0
private

Definition at line 117 of file melt_global.h.

§ xi_0

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::xi_0
private

Definition at line 118 of file melt_global.h.

§ eta_f

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::eta_f
private

Definition at line 119 of file melt_global.h.

§ thermal_viscosity_exponent

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

Definition at line 120 of file melt_global.h.

§ thermal_bulk_viscosity_exponent

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::thermal_bulk_viscosity_exponent
private

Definition at line 121 of file melt_global.h.

§ thermal_expansivity

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::thermal_expansivity
private

Definition at line 122 of file melt_global.h.

§ reference_specific_heat

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::reference_specific_heat
private

Definition at line 123 of file melt_global.h.

§ thermal_conductivity

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

Definition at line 124 of file melt_global.h.

§ reference_permeability

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::reference_permeability
private

Definition at line 125 of file melt_global.h.

§ alpha_phi

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::alpha_phi
private

Definition at line 126 of file melt_global.h.

§ depletion_density_change

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::depletion_density_change
private

Definition at line 127 of file melt_global.h.

§ depletion_solidus_change

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::depletion_solidus_change
private

Definition at line 128 of file melt_global.h.

§ pressure_solidus_change

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::pressure_solidus_change
private

Definition at line 129 of file melt_global.h.

§ surface_solidus

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::surface_solidus
private

Definition at line 130 of file melt_global.h.

§ compressibility

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::compressibility
private

Definition at line 131 of file melt_global.h.

§ melt_compressibility

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::melt_compressibility
private

Definition at line 132 of file melt_global.h.

§ include_melting_and_freezing

template<int dim>
bool aspect::MaterialModel::MeltGlobal< dim >::include_melting_and_freezing
private

Definition at line 133 of file melt_global.h.

§ melting_time_scale

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::melting_time_scale
private

Definition at line 134 of file melt_global.h.

§ alpha_depletion

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::alpha_depletion
private

Definition at line 135 of file melt_global.h.

§ delta_eta_depletion_max

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::delta_eta_depletion_max
private

Definition at line 136 of file melt_global.h.

§ peridotite_melting_entropy_change

template<int dim>
double aspect::MaterialModel::MeltGlobal< dim >::peridotite_melting_entropy_change
private

Definition at line 139 of file melt_global.h.


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