www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
PorousFlowMaterialBase Class Reference

Base class for all PorousFlow materials that provide phase-dependent properties. More...

#include <PorousFlowMaterialBase.h>

Inheritance diagram for PorousFlowMaterialBase:
[legend]

Public Member Functions

 PorousFlowMaterialBase (const InputParameters &parameters)
 

Protected Attributes

const unsigned int _phase_num
 Phase number of fluid. More...
 
const std::string _phase
 Stringified fluid phase number. More...
 

Detailed Description

Base class for all PorousFlow materials that provide phase-dependent properties.

These include: fluid properties, relative permeabilities and capillary pressures. and relative permeability classes. This base class checks that the specified fluid phase index is valid, and provides a stringified version of the phase index to use in the material property names.

Definition at line 26 of file PorousFlowMaterialBase.h.

Constructor & Destructor Documentation

PorousFlowMaterialBase::PorousFlowMaterialBase ( const InputParameters &  parameters)

Definition at line 21 of file PorousFlowMaterialBase.C.

22  : DerivativeMaterialInterface<PorousFlowMaterial>(parameters),
23  _phase_num(getParam<unsigned int>("phase")),
24  _phase(Moose::stringify(_phase_num))
25 {
26  if (_phase_num >= _dictator.numPhases())
27  mooseError("PorousFlowMaterial: The Dictator proclaims that the number of fluid phases is ",
28  _dictator.numPhases(),
29  " while you have foolishly entered phase = ",
30  _phase_num,
31  " in ",
32  _name,
33  ". Be aware that the Dictator does not tolerate mistakes.");
34 }
const unsigned int _phase_num
Phase number of fluid.
const std::string _phase
Stringified fluid phase number.

Member Data Documentation

const std::string PorousFlowMaterialBase::_phase
protected

Stringified fluid phase number.

Definition at line 36 of file PorousFlowMaterialBase.h.

const unsigned int PorousFlowMaterialBase::_phase_num
protected

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