ASPECT
Public Member Functions | Public Attributes | List of all members
aspect::MaterialModel::MaterialUtilities::PhaseFunctionInputs< dim > Struct Template Reference

Public Member Functions

 PhaseFunctionInputs (const double temperature, const double pressure, const double depth, const double pressure_depth_derivative, const unsigned int phase_index)
 

Public Attributes

double temperature
 
double pressure
 
double depth
 
double pressure_depth_derivative
 
unsigned int phase_index
 

Detailed Description

template<int dim>
struct aspect::MaterialModel::MaterialUtilities::PhaseFunctionInputs< dim >

A data structure with all inputs for the PhaseFunction::phase_function_value() and PhaseFunction::phase_function_derivative() method.

Definition at line 434 of file utilities.h.

Constructor & Destructor Documentation

§ PhaseFunctionInputs()

template<int dim>
aspect::MaterialModel::MaterialUtilities::PhaseFunctionInputs< dim >::PhaseFunctionInputs ( const double  temperature,
const double  pressure,
const double  depth,
const double  pressure_depth_derivative,
const unsigned int  phase_index 
)

Constructor. Initializes the various variables of this structure with the input values.

Member Data Documentation

§ temperature

template<int dim>
double aspect::MaterialModel::MaterialUtilities::PhaseFunctionInputs< dim >::temperature

Definition at line 446 of file utilities.h.

§ pressure

template<int dim>
double aspect::MaterialModel::MaterialUtilities::PhaseFunctionInputs< dim >::pressure

Definition at line 447 of file utilities.h.

§ depth

template<int dim>
double aspect::MaterialModel::MaterialUtilities::PhaseFunctionInputs< dim >::depth

Definition at line 448 of file utilities.h.

§ pressure_depth_derivative

template<int dim>
double aspect::MaterialModel::MaterialUtilities::PhaseFunctionInputs< dim >::pressure_depth_derivative

Definition at line 449 of file utilities.h.

§ phase_index

template<int dim>
unsigned int aspect::MaterialModel::MaterialUtilities::PhaseFunctionInputs< dim >::phase_index

This parameter determines which phase function of all the stored functions to compute. Phase functions are numbered consecutively, starting at 0 and the interpretation of their output is up to the calling side. For example the first phase function could be used to indicate a viscosity jump in the first compositional field, while the second function indicates a density jump in all compositions. None of this is known to the PhaseFunction object, which only has information that there are two phase functions and what their properties are.

Definition at line 462 of file utilities.h.


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