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

Public Member Functions

virtual void initialize ()
 
virtual bool is_compressible () const
 
virtual double reference_viscosity () const
 
virtual void evaluate (const MaterialModel::MaterialModelInputs< dim > &in, MaterialModel::MaterialModelOutputs< dim > &out) const
 
- Public Member Functions inherited from aspect::MaterialModel::Interface< dim >
virtual ~Interface ()
 
virtual void update ()
 
virtual void create_additional_named_outputs (MaterialModelOutputs &outputs) const
 
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
 

Private Attributes

std::string perplex_file_name
 
double eta
 
double k_value
 
double min_temperature
 
double max_temperature
 
double min_pressure
 
double max_pressure
 

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)
 
- Protected Attributes inherited from aspect::MaterialModel::Interface< dim >
NonlinearDependence::ModelDependence model_dependence
 

Detailed Description

template<int dim>
class aspect::MaterialModel::PerpleXLookup< dim >

A material model that calls the thermodynamic software PerpleX in order to evaluate material properties at a given point, namely the density, heat capacity, thermal expansivity and compressibility. The viscosity and thermal conductivity are globally constant.

The usual PerpleX input files are required in the working directory: an endmember dataset file, solution model dataset file and option file. The path to a PerpleX input file must be given by the user in the ASPECT parameter file; this file may be in any directory. PerpleX output files will be written to the same directory.

Compositional fields are used to define the bulk composition at each point. These compositional fields correspond to the components as given in the PerpleX input file. The order of components is preserved.

This model requires PerpleX. A script to download and setup the required files can be found in contrib/perplex. If the default installation directory is not changed, cmake will automatically find the required files during creation of the ASPECT build files. See ./contrib/perplex/README.md

WARNING: This model is extremely slow because there are many redundant calls to evaluate the material properties; it serves only as a proof of concept.

Definition at line 63 of file perplex_lookup.h.

Member Function Documentation

§ initialize()

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

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

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

§ is_compressible()

template<int dim>
virtual bool aspect::MaterialModel::PerpleXLookup< 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::PerpleXLookup< 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::PerpleXLookup< 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::PerpleXLookup< dim >::declare_parameters ( ParameterHandler prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
virtual void aspect::MaterialModel::PerpleXLookup< dim >::parse_parameters ( ParameterHandler prm)
virtual

Read the parameters this class declares from the parameter file.

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

Member Data Documentation

§ perplex_file_name

template<int dim>
std::string aspect::MaterialModel::PerpleXLookup< dim >::perplex_file_name
private

Definition at line 105 of file perplex_lookup.h.

§ eta

template<int dim>
double aspect::MaterialModel::PerpleXLookup< dim >::eta
private

Definition at line 106 of file perplex_lookup.h.

§ k_value

template<int dim>
double aspect::MaterialModel::PerpleXLookup< dim >::k_value
private

Definition at line 107 of file perplex_lookup.h.

§ min_temperature

template<int dim>
double aspect::MaterialModel::PerpleXLookup< dim >::min_temperature
private

Definition at line 108 of file perplex_lookup.h.

§ max_temperature

template<int dim>
double aspect::MaterialModel::PerpleXLookup< dim >::max_temperature
private

Definition at line 109 of file perplex_lookup.h.

§ min_pressure

template<int dim>
double aspect::MaterialModel::PerpleXLookup< dim >::min_pressure
private

Definition at line 110 of file perplex_lookup.h.

§ max_pressure

template<int dim>
double aspect::MaterialModel::PerpleXLookup< dim >::max_pressure
private

Definition at line 111 of file perplex_lookup.h.


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