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

Constructor & Destructor Documentation

◆ PorousFlowMaterialBase()

PorousFlowMaterialBase::PorousFlowMaterialBase ( const InputParameters & parameters )

Definition at line 23 of file PorousFlowMaterialBase.C.

   : DerivativeMaterialInterface<PorousFlowMaterial>(parameters),
     _phase_num(getParam<unsigned int>("phase")),
     _phase(Moose::stringify(_phase_num))
 {
   if (_phase_num >= _dictator.numPhases())
     paramError("phase",
                "The Dictator proclaims that the number of fluid phases is ",
                _dictator.numPhases(),
                " while you have foolishly entered ",
                _phase_num,
                ". Remember that indexing starts at 0. Be aware that the Dictator does not tolerate "
                "mistakes.");
 }

Member Data Documentation

◆ _phase

const std::string PorousFlowMaterialBase::_phase

protected

Stringified fluid phase number.

Definition at line 37 of file PorousFlowMaterialBase.h.

◆ _phase_num

const unsigned int PorousFlowMaterialBase::_phase_num

protected

Phase number of fluid.

Definition at line 34 of file PorousFlowMaterialBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties(), PorousFlowBrine::computeQpProperties(), PorousFlowSingleComponentFluid::computeQpProperties(), PorousFlowBrine::initQpStatefulProperties(), PorousFlowSingleComponentFluid::initQpStatefulProperties(), and PorousFlowMaterialBase().

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

porous_flow/include/materials/PorousFlowMaterialBase.h
porous_flow/src/materials/PorousFlowMaterialBase.C