PorousFlowDictator Class Reference

This holds maps between the nonlinear variables used in a PorousFlow simulation and the variable number used internally by MOOSE, as well as the number of fluid phases and the number of fluid components. More...

#include <PorousFlowDictator.h>

Inheritance diagram for PorousFlowDictator:

Public Member Functions
	PorousFlowDictator (const InputParameters &parameters)
virtual void	initialize () override
virtual void	execute () override
virtual void	finalize () override
unsigned int	numVariables () const
	The number of PorousFlow variables. More...
unsigned int	numPhases () const
	The number of fluid phases. More...
unsigned int	numComponents () const
	The number of fluid components. More...
unsigned int	numAqueousEquilibrium () const
	The number of aqueous equilibrium secondary species. More...
unsigned int	numAqueousKinetic () const
	The number of aqueous kinetic secondary species. More...
unsigned int	aqueousPhaseNumber () const
	The aqueous phase number. More...
unsigned int	porousFlowVariableNum (unsigned int moose_var_num) const
	The PorousFlow variable number. More...
unsigned int	mooseVariableNum (unsigned int porous_flow_var_num) const
	The Moose variable number. More...
bool	isPorousFlowVariable (unsigned int moose_var_num) const
	Returns true if moose_var_num is a porous flow variable. More...
bool	notPorousFlowVariable (unsigned int moose_var_num) const
	Returns true if moose_var_num is not a porous flow variabe. More...
bool	consistentFEType () const
	Whether the porous_flow_vars all have the same FEType or if no porous_flow_vars were provided. More...
FEType	feType () const
	The FEType of the first porous_flow_variable. More...
bool	usePermDerivs () const
	Check if the simulation includes derivatives of permeability Note: when the permeability is constant, expensive tensor calculations can be ignored in Jacobian calculations. More...
void	usePermDerivs (bool flag) const
	Set the _perm_derivs flag. More...

Protected Attributes
const unsigned int	_num_variables
	Number of PorousFlow variables. More...
const unsigned int	_num_phases
	Number of fluid phases. More...
const unsigned int	_num_components
	Number of fluid components. More...
const unsigned int	_num_aqueous_equilibrium
	Number of aqueous-equilibrium secondary species. More...
const unsigned int	_num_aqueous_kinetic
	Number of aqeuous-kinetic secondary species that are involved in mineralisation. More...
const unsigned int	_aqueous_phase_number
	Aqueous phase number. More...
bool	_perm_derivs
	Indicates whether the simulation includes derivatives of permeability. More...

Private Attributes
bool	_consistent_fe_type
	Whether the porous_flow_vars all have the same fe_type. More...
FEType	_fe_type
	FE type used by the PorousFlow variables. More...
std::vector< unsigned int >	_moose_var_num
	_moose_var_num[i] = the moose variable number corresponding to porous flow variable i More...
std::vector< unsigned int >	_pf_var_num
	_pf_var_num[i] = the porous flow variable corresponding to moose variable i More...

Detailed Description

This holds maps between the nonlinear variables used in a PorousFlow simulation and the variable number used internally by MOOSE, as well as the number of fluid phases and the number of fluid components.

The Dictator performs sanity checks on all PorousFlow simulations and helps users rectify errors (for instance if parts of the input file suggest it is a 2-phase simulation, while other parts suggest it is 1-phase).

All PorousFlow Materials and Kernels calculate and use derivatives with respect to all the variables mentioned in this Object, at least in principal (in practice they may be lazy and not compute all derivatives).

                              `  `:;@;:.:::#@@@'.`
                       `    ,@;@@@@@@@@@@@@@@@@@@@@'';''``
                 ,;@@@@@@@@@@@@T@@@@@H@@@@@E@@@@@@@@++@@@+:.:.`
        '@@'@@@@@@@D@@@@@I@@@@@C@@@@@T@@@@@A@@@@@T@@@@@O@@@@@R@@@@@@..`
 `..,;@@@@@@@@@@@@@@@@@@@@@@@@@@@@I@@@@@S@@@@@@@@@@@@@@@@@@@@@@@@@@@;.

.:@@@@@@@@@@W@@@A@@@T@@@C@@@H@@@I@@@N@@@G@@@@#;:. .:@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@:,@@@@@@@@@@+ ,@@@@@@@@@@@';'@@@@@@@@@@:@@@@+@+:;@@@@@@@;:#';::'@@@@@@. `::;,..`::+:,;@@@@@@:. ‘’@@@'...,,.... ` ..:;@@@@@@@@+. @;;;;@;,, `:@@@@@@:` @@++';:,.;+@#:,. @@@@#+:. ‘,@@@@@@@@@@@@@@’@@+:. ‘.:’::, @@@:,...,@@@@@, +@@@@@@@@@@@@;'@@# .,,,, @@@':::@@@@.@@@@@@@@@@@@@@@@. ,@@@` `.::, @@@@@@#@@@@@';. `@@@@@@@@;,@`@@@@@@@@@@@@@@@@@@@@@@@@@@@@@` .,@@@@.., @@@@@:.. @@@, ;@@@@@@@@@ ,@@@:@@@ ‘,’@@ . @@@@@':,,` @@@@:` @@@@@@@@@@@@@@@@@@ ,@@: `:@@@@@; ..:@@@` @@;:‘ @@@.. ’@@@@@@@@@ @@ .@@@,‘:’@. @@@@;:.@@@, `‘ @@@@@@@@@@@@@ ,@@@.’@@,‘ @+’:'';@@@@@@,, @@@@@@@@@@@' ‘.:@#@:@@’:. :;;;:@,,.@+, +. @@@@@@@@@@@@@@@@@@@@ . @@:';,,,.` .,,,,,,;;+;:.`..;,., ,,` @@@@@@@@@@@@@@@@` ,@, ` `......,,;+++#';@@@@@@. '@@@@@@; .;@@. ```,;'+@+;:'@@'@@@:. ‘ ,#@@+, .:+’@';::'+':,;,#@@@@@@@@@: .@@@@: :,,::,....,,..,,,,...,,,,,...:;@@@@; .....`,...,,,,,.....

Definition at line 71 of file PorousFlowDictator.h.

Constructor & Destructor Documentation

PorousFlowDictator()

PorousFlowDictator::PorousFlowDictator

(

const InputParameters &

parameters

)

Definition at line 50 of file PorousFlowDictator.C.

  : GeneralUserObject(parameters),
    Coupleable(this, false),
    _num_variables(coupledComponents("porous_flow_vars")),
    _num_phases(getParam<unsigned int>("number_fluid_phases")),
    _num_components(getParam<unsigned int>("number_fluid_components")),
    _num_aqueous_equilibrium(getParam<unsigned int>("number_aqueous_equilibrium")),
    _num_aqueous_kinetic(getParam<unsigned int>("number_aqueous_kinetic")),
    _aqueous_phase_number(getParam<unsigned int>("aqueous_phase_number")),
    _consistent_fe_type(false),
    _fe_type(0)
{
  _moose_var_num.resize(_num_variables);
  for (unsigned int i = 0; i < _num_variables; ++i)
    _moose_var_num[i] = coupled("porous_flow_vars", i);
 
  if (_num_variables > 0)
  {
    _consistent_fe_type = true;
    _fe_type = FEType(getVar("porous_flow_vars", 0)->feType());
    for (unsigned int i = 1; i < _num_variables; ++i)
      if (getVar("porous_flow_vars", i)->feType() != _fe_type)
        _consistent_fe_type = false;
  }
 
  _pf_var_num.assign(_fe_problem.getNonlinearSystemBase().nVariables(),
                     _num_variables); // Note: the _num_variables assignment indicates that "this is
                                      // not a PorousFlow variable"
  for (unsigned int i = 0; i < _num_variables; ++i)
    if (_moose_var_num[i] < _pf_var_num.size())
      _pf_var_num[_moose_var_num[i]] = i;
    else
      // should not couple AuxVariables to the Dictator (Jacobian entries are not calculated for
      // them)
      mooseError("PorousFlowDictator: AuxVariables variables must not be coupled into the Dictator "
                 "for this is against specification #1984.  Variable number ",
                 i,
                 " is an AuxVariable.");
 
  if ((_num_phases > 0) && (_aqueous_phase_number >= _num_phases))
    mooseError("PorousflowDictator: The aqueous phase number must be less than the number of fluid "
               "phases.  The Dictator does not appreciate jokes.");
 
  // Don't include permeabiity derivatives in the Jacobian by default (overwrite using
  // usePermDerivs()) when necessary in permeabiity material classes
  _perm_derivs = false;
}

Member Function Documentation

aqueousPhaseNumber()

unsigned int PorousFlowDictator::aqueousPhaseNumber

(

)

const

The aqueous phase number.

Definition at line 129 of file PorousFlowDictator.C.

{
  return _aqueous_phase_number;
}

consistentFEType()

bool PorousFlowDictator::consistentFEType

(

)

const

Whether the porous_flow_vars all have the same FEType or if no porous_flow_vars were provided.

Definition at line 167 of file PorousFlowDictator.C.

{
  return _consistent_fe_type;
}

Referenced by PorousFlowAdvectiveFluxCalculatorBase::PorousFlowAdvectiveFluxCalculatorBase().

execute()

virtual void PorousFlowDictator::execute ( )

inlineoverridevirtual

Definition at line 77 of file PorousFlowDictator.h.

{};

feType()

FEType PorousFlowDictator::feType

(

)

const

The FEType of the first porous_flow_variable.

Note, this is meaningless if there are no named porous_flow_variables: consistentFEType() should be used to check this

Definition at line 173 of file PorousFlowDictator.C.

{
  return _fe_type;
}

Referenced by PorousFlowDictator().

finalize()

virtual void PorousFlowDictator::finalize ( )

inlineoverridevirtual

Definition at line 78 of file PorousFlowDictator.h.

{};

initialize()

virtual void PorousFlowDictator::initialize ( )

inlineoverridevirtual

Definition at line 76 of file PorousFlowDictator.h.

{};

isPorousFlowVariable()

bool PorousFlowDictator::isPorousFlowVariable

(

unsigned int

moose_var_num

)

const

Returns true if moose_var_num is a porous flow variable.

Parameters

moose_var_num

the MOOSE variable number eg if porous_flow_vars = 'pwater pgas', and the variables in the simulation are 'energy pwater pgas shape' then isPorousFlowVariable(0) = false, isPorousFlowVariable(1) = true

Definition at line 155 of file PorousFlowDictator.C.

{
  return !notPorousFlowVariable(moose_var_num);
}

mooseVariableNum()

unsigned int PorousFlowDictator::mooseVariableNum

(

unsigned int

porous_flow_var_num

)

const

The Moose variable number.

Parameters

porous_flow_var_num

the PorousFlow variable number eg if porous_flow_vars = 'pwater pgas', and the variables in the simulation are 'energy pwater pgas shape' then mooseVariableNum(1) = 2

Definition at line 145 of file PorousFlowDictator.C.

{
  if (porous_flow_var_num >= _num_variables)
    mooseError("The Dictator proclaims that there is no such PorousFlow variable with number ",
               porous_flow_var_num,
               ".  Exiting with error code 1984.");
  return _moose_var_num[porous_flow_var_num];
}

Referenced by PorousFlowFluxLimitedTVDAdvection::computeJacobian().

notPorousFlowVariable()

bool PorousFlowDictator::notPorousFlowVariable

(

unsigned int

moose_var_num

)

const

Returns true if moose_var_num is not a porous flow variabe.

Parameters

moose_var_num

the MOOSE variable number eg if porous_flow_vars = 'pwater pgas', and the variables in the simulation are 'energy pwater pgas shape' then notPorousFlowVariable(0) = true, notPorousFlowVariable(1) = false

Definition at line 161 of file PorousFlowDictator.C.

{
  return moose_var_num >= _pf_var_num.size() || _pf_var_num[moose_var_num] == _num_variables;
}

Referenced by PorousFlowHeatVolumetricExpansion::computedEnergyQpJac(), PorousFlowMassVolumetricExpansion::computedMassQpJac(), PorousFlowHeatVolumetricExpansion::computedVolQpJac(), PorousFlowMassVolumetricExpansion::computedVolQpJac(), PorousFlowPolyLineSink::computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), PorousFlowDispersiveFlux::computeQpJac(), PorousFlowDesorpedMassTimeDerivative::computeQpJac(), PorousFlowDesorpedMassVolumetricExpansion::computeQpJac(), PorousFlowPreDis::computeQpJacobian(), PorousFlowEffectiveStressCoupling::computeQpJacobian(), PorousFlowHeatConduction::computeQpOffDiagJacobian(), PorousFlowBasicAdvection::computeQpOffDiagJacobian(), PorousFlowPlasticHeatEnergy::computeQpOffDiagJacobian(), PorousFlowEnergyTimeDerivative::computeQpOffDiagJacobian(), PorousFlowFullySaturatedMassTimeDerivative::computeQpOffDiagJacobian(), PorousFlowPreDis::computeQpOffDiagJacobian(), PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian(), PorousFlowMassTimeDerivative::computeQpOffDiagJacobian(), PorousFlowEffectiveStressCoupling::computeQpOffDiagJacobian(), PorousFlowMassRadioactiveDecay::computeQpOffDiagJacobian(), PorousFlowDarcyBase::computeResidualAndJacobian(), PorousFlowDarcyBase::darcyQpJacobian(), isPorousFlowVariable(), PorousFlowLineSink::jac(), and PorousFlowSink::jac().

numAqueousEquilibrium()

unsigned int PorousFlowDictator::numAqueousEquilibrium

(

)

const

The number of aqueous equilibrium secondary species.

Definition at line 117 of file PorousFlowDictator.C.

{
  return _num_aqueous_equilibrium;
}

Referenced by PorousFlowPropertyAux::PorousFlowPropertyAux().

numAqueousKinetic()

unsigned int PorousFlowDictator::numAqueousKinetic

(

)

const

The number of aqueous kinetic secondary species.

Definition at line 123 of file PorousFlowDictator.C.

{
  return _num_aqueous_kinetic;
}

Referenced by PorousFlowPreDis::computeQpJac(), PorousFlowPreDis::computeQpResidual(), PorousFlowPreDis::PorousFlowPreDis(), and PorousFlowPropertyAux::PorousFlowPropertyAux().

numComponents()

unsigned int PorousFlowDictator::numComponents

(

)

const

The number of fluid components.

Definition at line 111 of file PorousFlowDictator.C.

{
  return _num_components;
}

Referenced by PorousFlowAdvectiveFluxCalculatorSaturatedMultiComponent::PorousFlowAdvectiveFluxCalculatorSaturatedMultiComponent(), PorousFlowFluidMass::PorousFlowFluidMass(), PorousFlowFullySaturatedDarcyFlow::PorousFlowFullySaturatedDarcyFlow(), PorousFlowFullySaturatedMassTimeDerivative::PorousFlowFullySaturatedMassTimeDerivative(), PorousFlowLineSink::PorousFlowLineSink(), PorousFlowMassRadioactiveDecay::PorousFlowMassRadioactiveDecay(), PorousFlowMassTimeDerivative::PorousFlowMassTimeDerivative(), PorousFlowMassVolumetricExpansion::PorousFlowMassVolumetricExpansion(), PorousFlowPropertyAux::PorousFlowPropertyAux(), and PorousFlowSink::PorousFlowSink().

numPhases()

unsigned int PorousFlowDictator::numPhases

(

)

const

The number of fluid phases.

Definition at line 105 of file PorousFlowDictator.C.

{
  return _num_phases;
}

Referenced by PorousFlowAdvectiveFluxCalculatorBase::PorousFlowAdvectiveFluxCalculatorBase(), PorousFlowBasicAdvection::PorousFlowBasicAdvection(), PorousFlowDarcyVelocityComponent::PorousFlowDarcyVelocityComponent(), PorousFlowFluidMass::PorousFlowFluidMass(), PorousFlowFullySaturatedDarcyBase::PorousFlowFullySaturatedDarcyBase(), PorousFlowFullySaturatedMassTimeDerivative::PorousFlowFullySaturatedMassTimeDerivative(), PorousFlowLineSink::PorousFlowLineSink(), PorousFlowPropertyAux::PorousFlowPropertyAux(), and PorousFlowSink::PorousFlowSink().

numVariables()

unsigned int PorousFlowDictator::numVariables

(

)

const

The number of PorousFlow variables.

Materials and Kernels will calculate and use derivatives with respect to these variables in the Jacobian

Definition at line 99 of file PorousFlowDictator.C.

{
  return _num_variables;
}

Referenced by PorousFlowFluxLimitedTVDAdvection::computeJacobian(), PorousFlowFluidMass::PorousFlowFluidMass(), and PorousFlowHeatEnergy::PorousFlowHeatEnergy().

porousFlowVariableNum()

unsigned int PorousFlowDictator::porousFlowVariableNum

(

unsigned int

moose_var_num

)

const

The PorousFlow variable number.

Parameters

moose_var_num

the MOOSE variable number eg if porous_flow_vars = 'pwater pgas', and the variables in the simulation are 'energy pwater pgas shape' then porousFlowVariableNum(2) = 1

Definition at line 135 of file PorousFlowDictator.C.

{
  if (moose_var_num >= _pf_var_num.size() || _pf_var_num[moose_var_num] == _num_variables)
    mooseError("The Dictator proclaims that the moose variable with number ",
               moose_var_num,
               " is not a PorousFlow variable.  Exiting with error code 1984.");
  return _pf_var_num[moose_var_num];
}

Referenced by PorousFlowHeatVolumetricExpansion::computedEnergyQpJac(), PorousFlowMassVolumetricExpansion::computedMassQpJac(), PorousFlowHeatVolumetricExpansion::computedVolQpJac(), PorousFlowMassVolumetricExpansion::computedVolQpJac(), PorousFlowPolyLineSink::computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), PorousFlowDispersiveFlux::computeQpJac(), PorousFlowDesorpedMassTimeDerivative::computeQpJac(), PorousFlowDesorpedMassVolumetricExpansion::computeQpJac(), PorousFlowEnergyTimeDerivative::computeQpJacobian(), PorousFlowFullySaturatedMassTimeDerivative::computeQpJacobian(), PorousFlowPreDis::computeQpJacobian(), PorousFlowMassTimeDerivative::computeQpJacobian(), PorousFlowMassRadioactiveDecay::computeQpJacobian(), PorousFlowEffectiveStressCoupling::computeQpJacobian(), PorousFlowHeatConduction::computeQpOffDiagJacobian(), PorousFlowBasicAdvection::computeQpOffDiagJacobian(), PorousFlowPlasticHeatEnergy::computeQpOffDiagJacobian(), PorousFlowEnergyTimeDerivative::computeQpOffDiagJacobian(), PorousFlowFullySaturatedMassTimeDerivative::computeQpOffDiagJacobian(), PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian(), PorousFlowPreDis::computeQpOffDiagJacobian(), PorousFlowMassTimeDerivative::computeQpOffDiagJacobian(), PorousFlowMassRadioactiveDecay::computeQpOffDiagJacobian(), PorousFlowEffectiveStressCoupling::computeQpOffDiagJacobian(), PorousFlowDarcyBase::computeResidualAndJacobian(), PorousFlowDarcyBase::darcyQpJacobian(), PorousFlowLineSink::jac(), and PorousFlowSink::jac().

usePermDerivs() [1/2]

bool PorousFlowDictator::usePermDerivs ( ) const

inline

Check if the simulation includes derivatives of permeability Note: when the permeability is constant, expensive tensor calculations can be ignored in Jacobian calculations.

Definition at line 156 of file PorousFlowDictator.h.

{ return _perm_derivs; };

usePermDerivs() [2/2]

void PorousFlowDictator::usePermDerivs ( bool  flag ) const

inline

Set the _perm_derivs flag.

Definition at line 161 of file PorousFlowDictator.h.

{ _perm_derivs = flag; };

Member Data Documentation

_aqueous_phase_number

const unsigned int PorousFlowDictator::_aqueous_phase_number

protected

Aqueous phase number.

Definition at line 180 of file PorousFlowDictator.h.

Referenced by aqueousPhaseNumber(), and PorousFlowDictator().

_consistent_fe_type

bool PorousFlowDictator::_consistent_fe_type

private

Whether the porous_flow_vars all have the same fe_type.

Definition at line 187 of file PorousFlowDictator.h.

Referenced by consistentFEType(), and PorousFlowDictator().

_fe_type

FEType PorousFlowDictator::_fe_type

private

FE type used by the PorousFlow variables.

Definition at line 190 of file PorousFlowDictator.h.

Referenced by feType(), and PorousFlowDictator().

_moose_var_num

std::vector<unsigned int> PorousFlowDictator::_moose_var_num

private

_moose_var_num[i] = the moose variable number corresponding to porous flow variable i

Definition at line 193 of file PorousFlowDictator.h.

Referenced by mooseVariableNum(), and PorousFlowDictator().

_num_aqueous_equilibrium

const unsigned int PorousFlowDictator::_num_aqueous_equilibrium

protected

Number of aqueous-equilibrium secondary species.

Definition at line 174 of file PorousFlowDictator.h.

Referenced by numAqueousEquilibrium().

_num_aqueous_kinetic

const unsigned int PorousFlowDictator::_num_aqueous_kinetic

protected

Number of aqeuous-kinetic secondary species that are involved in mineralisation.

Definition at line 177 of file PorousFlowDictator.h.

Referenced by numAqueousKinetic().

_num_components

const unsigned int PorousFlowDictator::_num_components

protected

Number of fluid components.

Definition at line 171 of file PorousFlowDictator.h.

Referenced by numComponents().

_num_phases

const unsigned int PorousFlowDictator::_num_phases

protected

Number of fluid phases.

Definition at line 168 of file PorousFlowDictator.h.

Referenced by numPhases(), and PorousFlowDictator().

_num_variables

const unsigned int PorousFlowDictator::_num_variables

protected

Number of PorousFlow variables.

Definition at line 161 of file PorousFlowDictator.h.

Referenced by mooseVariableNum(), notPorousFlowVariable(), numVariables(), PorousFlowDictator(), and porousFlowVariableNum().

_perm_derivs

bool PorousFlowDictator::_perm_derivs

mutableprotected

Indicates whether the simulation includes derivatives of permeability.

Definition at line 183 of file PorousFlowDictator.h.

Referenced by PorousFlowDictator(), and usePermDerivs().

_pf_var_num

std::vector<unsigned int> PorousFlowDictator::_pf_var_num

private

_pf_var_num[i] = the porous flow variable corresponding to moose variable i

Definition at line 196 of file PorousFlowDictator.h.

Referenced by notPorousFlowVariable(), PorousFlowDictator(), and porousFlowVariableNum().

---

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

• porous_flow/include/userobjects/PorousFlowDictator.h
• porous_flow/src/userobjects/PorousFlowDictator.C