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:

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 28 of file PorousFlowMaterialBase.h.

Constructor & Destructor Documentation

◆ PorousFlowMaterialBase()

PorousFlowMaterialBase::PorousFlowMaterialBase ( const InputParameters &  parameters)

Definition at line 23 of file PorousFlowMaterialBase.C.

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

Member Data Documentation

◆ _phase

const std::string PorousFlowMaterialBase::_phase

Stringified fluid phase number.

Definition at line 38 of file PorousFlowMaterialBase.h.

◆ _phase_num

const unsigned int PorousFlowMaterialBase::_phase_num

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