PorousFlowUnsaturated Class Reference

Action for simulation involving a single phase, partially or fully saturated fluid. More...

#include <PorousFlowUnsaturated.h>

Inheritance diagram for PorousFlowUnsaturated:

Public Member Functions
	PorousFlowUnsaturated (const InputParameters &params)
virtual void	act () override
virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type) override

Protected Types
enum	RelpermTypeChoiceEnum { RelpermTypeChoiceEnum::FLAC, RelpermTypeChoiceEnum::COREY }
	Fluid relative permeability type (FLAC or Corey) More...
enum	CouplingTypeEnum { CouplingTypeEnum::Hydro, CouplingTypeEnum::ThermoHydro, CouplingTypeEnum::HydroMechanical, CouplingTypeEnum::ThermoHydroMechanical }
	Determines the coupling type. More...
enum	StabilizationEnum { StabilizationEnum::Full, StabilizationEnum::KT }

Protected Member Functions
virtual void	addKernels () override
	Add all Kernels. More...
virtual void	addAuxObjects () override
	Add all AuxVariables and AuxKernels. More...
virtual void	addMaterialDependencies () override
	Add all material dependencies so that the correct version of each material can be added. More...
virtual void	addMaterials () override
	Add all Materials. More...
virtual void	addUserObjects () override
	Add all other UserObjects. More...
virtual void	addDictator () override
	Add the PorousFlowDictator object. More...
void	addSaturationAux (unsigned phase)
	Add an AuxVariable and AuxKernel to calculate saturation. More...
void	addDarcyAux (const RealVectorValue &gravity)
	Add AuxVariables and AuxKernels to calculate Darcy velocity. More...
void	addStressAux ()
	Add AuxVariables and AuxKernels to compute effective stress. More...
void	addTemperatureMaterial (bool at_nodes)
	Adds a nodal and a quadpoint Temperature material. More...
void	addMassFractionMaterial (bool at_nodes)
	Adds a nodal and a quadpoint MassFraction material. More...
void	addEffectiveFluidPressureMaterial (bool at_nodes)
	Adds a nodal and a quadpoint effective fluid pressure material. More...
void	addVolumetricStrainMaterial (const std::vector< VariableName > &displacements, bool consistent_with_displaced_mesh)
	Adds a quadpoint volumetric strain material. More...
void	addSingleComponentFluidMaterial (bool at_nodes, unsigned phase, bool compute_density_and_viscosity, bool compute_internal_energy, bool compute_enthalpy, const UserObjectName &fp)
	Adds a single-component fluid Material. More...
void	addBrineMaterial (const VariableName xnacl, bool at_nodes, unsigned phase, bool compute_density_and_viscosity, bool compute_internal_energy, bool compute_enthalpy)
	Adds a brine fluid Material. More...
void	addRelativePermeabilityCorey (bool at_nodes, unsigned phase, Real n, Real s_res, Real sum_s_res)
	Adds a relative-permeability Material of the Corey variety. More...
void	addRelativePermeabilityFLAC (bool at_nodes, unsigned phase, Real m, Real s_res, Real sum_s_res)
	Adds a relative-permeability Material of the FLAC variety. More...
void	addCapillaryPressureVG (Real m, Real alpha, std::string userobject_name)
	Adds a van Genuchten capillary pressure UserObject. More...
void	addAdvectiveFluxCalculatorSaturated (unsigned phase, bool multiply_by_density, std::string userobject_name)
void	addAdvectiveFluxCalculatorUnsaturated (unsigned phase, bool multiply_by_density, std::string userobject_name)
void	addAdvectiveFluxCalculatorSaturatedHeat (unsigned phase, bool multiply_by_density, std::string userobject_name)
void	addAdvectiveFluxCalculatorUnsaturatedHeat (unsigned phase, bool multiply_by_density, std::string userobject_name)
void	addAdvectiveFluxCalculatorSaturatedMultiComponent (unsigned phase, unsigned fluid_component, bool multiply_by_density, std::string userobject_name)
void	addAdvectiveFluxCalculatorUnsaturatedMultiComponent (unsigned phase, unsigned fluid_component, bool multiply_by_density, std::string userobject_name)

Protected Attributes
const bool	_add_saturation_aux
	Add an Aux Variable to record saturation. More...
const Real	_van_genuchten_alpha
	Van Genuchten alpha parameter. More...
const Real	_van_genuchten_m
	Van Genuchten m parameter. More...
enum PorousFlowUnsaturated::RelpermTypeChoiceEnum	_relperm_type
const Real	_relative_permeability_exponent
	Relative permeability exponent. More...
const Real	_s_res
	Residual saturation to use in the relative permeability expressions. More...
const std::string	_capillary_pressure_name
	Name of the capillary pressure UserObject. More...
const VariableName	_pp_var
	Porepressure NonlinearVariable name. More...
enum PorousFlowSinglePhaseBase::CouplingTypeEnum	_coupling_type
const bool	_thermal
	Flags to indicate whether thermal or mechanical effects are included. More...
const bool	_mechanical
const UserObjectName &	_fp
	Name of the fluid-properties UserObject. More...
const Real	_biot_coefficient
	Fluid specific heat capacity at constant volume. More...
const bool	_add_darcy_aux
	Add a AuxVariables to record Darcy velocity. More...
const bool	_add_stress_aux
	Add AuxVariables for stress. More...
const bool	_use_brine
	Use PorousFlowBrine material. More...
const unsigned	_nacl_index
	Index of NaCl in list of fluid components. More...
std::vector< std::string >	_included_objects
	List of Kernels, AuxKernels, Materials, etc, that are added in this input file. More...
const std::string	_dictator_name
	The name of the PorousFlowDictator object to be added. 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 RealVectorValue	_gravity
	Gravity. More...
const std::vector< VariableName > &	_mass_fraction_vars
	Name of the mass-fraction variables (if any) More...
const unsigned	_num_mass_fraction_vars
	Number of mass-fraction variables. More...
const std::vector< VariableName > &	_temperature_var
	Name of the temperature variable (if any) More...
const std::vector< VariableName > &	_displacements
	Displacement NonlinearVariable names (if any) More...
const unsigned	_ndisp
	Number of displacement variables supplied. More...
std::vector< VariableName >	_coupled_displacements
	Displacement Variable names. More...
const MooseEnum	_flux_limiter_type
	Flux limiter type in the Kuzmin-Turek FEM-TVD stabilization scheme. More...
enum PorousFlowActionBase::StabilizationEnum	_stabilization
Moose::CoordinateSystemType	_coord_system
	Coordinate system of the simulation (eg RZ, XYZ, etc) More...
bool	_transient
	Flag to denote if the simulation is transient. More...
DependencyResolver< std::string >	_deps
	All dependencies of kernels, auxkernels, materials, etc, are stored in _dependencies. More...

Detailed Description

Action for simulation involving a single phase, partially or fully saturated fluid.

The fluid's saturation is found using the van-Genuchten expression, and the relative permeability is found using the FLAC or Corey expression.

Definition at line 24 of file PorousFlowUnsaturated.h.

Member Enumeration Documentation

CouplingTypeEnum

enum PorousFlowSinglePhaseBase::CouplingTypeEnum

strongprotectedinherited

Determines the coupling type.

Enumerator
Hydro
ThermoHydro
HydroMechanical
ThermoHydroMechanical

Definition at line 38 of file PorousFlowSinglePhaseBase.h.

                                    {
    Hydro,
    ThermoHydro,
    HydroMechanical,
    ThermoHydroMechanical
  } _coupling_type;

RelpermTypeChoiceEnum

enum PorousFlowUnsaturated::RelpermTypeChoiceEnum

strongprotected

Fluid relative permeability type (FLAC or Corey)

Enumerator
FLAC
COREY

Definition at line 46 of file PorousFlowUnsaturated.h.

{ FLAC, COREY } _relperm_type;

StabilizationEnum

enum PorousFlowActionBase::StabilizationEnum

strongprotectedinherited

Enumerator
Full
KT

Definition at line 86 of file PorousFlowActionBase.h.

{ Full, KT } _stabilization;

Constructor & Destructor Documentation

PorousFlowUnsaturated()

PorousFlowUnsaturated::PorousFlowUnsaturated

(

const InputParameters &

params

)

Definition at line 68 of file PorousFlowUnsaturated.C.

  : PorousFlowSinglePhaseBase(params),
    _add_saturation_aux(getParam<bool>("add_saturation_aux")),
    _van_genuchten_alpha(getParam<Real>("van_genuchten_alpha")),
    _van_genuchten_m(getParam<Real>("van_genuchten_m")),
    _relperm_type(
        getParam<MooseEnum>("relative_permeability_type").getEnum<RelpermTypeChoiceEnum>()),
    _relative_permeability_exponent(getParam<Real>("relative_permeability_exponent")),
    _s_res(getParam<Real>("residual_saturation")),
    _capillary_pressure_name("PorousFlowUnsaturated_CapillaryPressureVG")
{
}

Member Function Documentation

act()

void PorousFlowActionBase::act ( )

overridevirtualinherited

Definition at line 115 of file PorousFlowActionBase.C.

{
  // Check if the simulation is transient (note: can't do this in the ctor)
  _transient = _problem->isTransient();
 
  // Make sure that all mesh subdomains have the same coordinate system
  const auto & all_subdomains = _problem->mesh().meshSubdomains();
  if (all_subdomains.empty())
    mooseError("No subdomains found");
  _coord_system = _problem->getCoordSystem(*all_subdomains.begin());
  for (const auto & subdomain : all_subdomains)
    if (_problem->getCoordSystem(subdomain) != _coord_system)
      mooseError(
          "The PorousFlow Actions require all subdomains to have the same coordinate system.");
 
  // Note: this must be called before addMaterials!
  addMaterialDependencies();
 
  // Make the vector of added objects unique
  std::sort(_included_objects.begin(), _included_objects.end());
  _included_objects.erase(std::unique(_included_objects.begin(), _included_objects.end()),
                          _included_objects.end());
 
  if (_current_task == "add_user_object")
    addUserObjects();
 
  if (_current_task == "add_aux_variable" || _current_task == "add_aux_kernel")
    addAuxObjects();
 
  if (_current_task == "add_kernel")
    addKernels();
 
  if (_current_task == "add_material")
    addMaterials();
}

addAdvectiveFluxCalculatorSaturated()

void PorousFlowActionBase::addAdvectiveFluxCalculatorSaturated ( unsigned  phase, bool  multiply_by_density, std::string  userobject_name  )

protectedinherited

Definition at line 544 of file PorousFlowActionBase.C.

{
  if (_stabilization == StabilizationEnum::KT && _current_task == "add_user_object")
  {
    const std::string userobject_type = "PorousFlowAdvectiveFluxCalculatorSaturated";
    InputParameters params = _factory.getValidParams(userobject_type);
    params.set<MooseEnum>("flux_limiter_type") = _flux_limiter_type;
    params.set<RealVectorValue>("gravity") = _gravity;
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<unsigned>("phase") = phase;
    params.set<bool>("multiply_by_density") = multiply_by_density;
    _problem->addUserObject(userobject_type, userobject_name, params);
  }
}

Referenced by PorousFlowFullySaturated::addUserObjects().

addAdvectiveFluxCalculatorSaturatedHeat()

void PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedHeat ( unsigned  phase, bool  multiply_by_density, std::string  userobject_name  )

protectedinherited

Definition at line 580 of file PorousFlowActionBase.C.

{
  if (_stabilization == StabilizationEnum::KT && _current_task == "add_user_object")
  {
    const std::string userobject_type = "PorousFlowAdvectiveFluxCalculatorSaturatedHeat";
    InputParameters params = _factory.getValidParams(userobject_type);
    params.set<MooseEnum>("flux_limiter_type") = _flux_limiter_type;
    params.set<RealVectorValue>("gravity") = _gravity;
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<unsigned>("phase") = phase;
    params.set<bool>("multiply_by_density") = multiply_by_density;
    _problem->addUserObject(userobject_type, userobject_name, params);
  }
}

Referenced by PorousFlowFullySaturated::addUserObjects().

addAdvectiveFluxCalculatorSaturatedMultiComponent()

void PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedMultiComponent ( unsigned  phase, unsigned  fluid_component, bool  multiply_by_density, std::string  userobject_name  )

protectedinherited

Definition at line 616 of file PorousFlowActionBase.C.

{
  if (_stabilization == StabilizationEnum::KT && _current_task == "add_user_object")
  {
    const std::string userobject_type = "PorousFlowAdvectiveFluxCalculatorSaturatedMultiComponent";
    InputParameters params = _factory.getValidParams(userobject_type);
    params.set<MooseEnum>("flux_limiter_type") = _flux_limiter_type;
    params.set<RealVectorValue>("gravity") = _gravity;
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<unsigned>("phase") = phase;
    params.set<bool>("multiply_by_density") = multiply_by_density;
    params.set<unsigned>("fluid_component") = fluid_component;
    _problem->addUserObject(userobject_type, userobject_name, params);
  }
}

Referenced by PorousFlowFullySaturated::addUserObjects().

addAdvectiveFluxCalculatorUnsaturated()

void PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturated ( unsigned  phase, bool  multiply_by_density, std::string  userobject_name  )

protectedinherited

Definition at line 562 of file PorousFlowActionBase.C.

{
  if (_stabilization == StabilizationEnum::KT && _current_task == "add_user_object")
  {
    const std::string userobject_type = "PorousFlowAdvectiveFluxCalculatorUnsaturated";
    InputParameters params = _factory.getValidParams(userobject_type);
    params.set<MooseEnum>("flux_limiter_type") = _flux_limiter_type;
    params.set<RealVectorValue>("gravity") = _gravity;
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<unsigned>("phase") = phase;
    params.set<bool>("multiply_by_density") = multiply_by_density;
    _problem->addUserObject(userobject_type, userobject_name, params);
  }
}

Referenced by addUserObjects().

addAdvectiveFluxCalculatorUnsaturatedHeat()

void PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedHeat ( unsigned  phase, bool  multiply_by_density, std::string  userobject_name  )

protectedinherited

Definition at line 598 of file PorousFlowActionBase.C.

{
  if (_stabilization == StabilizationEnum::KT && _current_task == "add_user_object")
  {
    const std::string userobject_type = "PorousFlowAdvectiveFluxCalculatorUnsaturatedHeat";
    InputParameters params = _factory.getValidParams(userobject_type);
    params.set<MooseEnum>("flux_limiter_type") = _flux_limiter_type;
    params.set<RealVectorValue>("gravity") = _gravity;
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<unsigned>("phase") = phase;
    params.set<bool>("multiply_by_density") = multiply_by_density;
    _problem->addUserObject(userobject_type, userobject_name, params);
  }
}

Referenced by addUserObjects().

addAdvectiveFluxCalculatorUnsaturatedMultiComponent()

void PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedMultiComponent ( unsigned  phase, unsigned  fluid_component, bool  multiply_by_density, std::string  userobject_name  )

protectedinherited

Definition at line 636 of file PorousFlowActionBase.C.

{
  if (_stabilization == StabilizationEnum::KT && _current_task == "add_user_object")
  {
    const std::string userobject_type =
        "PorousFlowAdvectiveFluxCalculatorUnsaturatedMultiComponent";
    InputParameters params = _factory.getValidParams(userobject_type);
    params.set<MooseEnum>("flux_limiter_type") = _flux_limiter_type;
    params.set<RealVectorValue>("gravity") = _gravity;
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<unsigned>("phase") = phase;
    params.set<bool>("multiply_by_density") = multiply_by_density;
    params.set<unsigned>("fluid_component") = fluid_component;
    _problem->addUserObject(userobject_type, userobject_name, params);
  }
}

Referenced by addUserObjects().

addAuxObjects()

void PorousFlowUnsaturated::addAuxObjects ( )

overrideprotectedvirtual

Add all AuxVariables and AuxKernels.

Reimplemented from PorousFlowSinglePhaseBase.

Definition at line 305 of file PorousFlowUnsaturated.C.

{
  PorousFlowSinglePhaseBase::addAuxObjects();
 
  if (_add_saturation_aux)
    addSaturationAux(0);
}

addBrineMaterial()

void PorousFlowActionBase::addBrineMaterial ( const VariableName  xnacl, bool  at_nodes, unsigned  phase, bool  compute_density_and_viscosity, bool  compute_internal_energy, bool  compute_enthalpy  )

protectedinherited

Adds a brine fluid Material.

Parameters

xnacl	the variable containing the mass fraction of NaCl in the fluid
phase	the phase number of the fluid
compute_density_and_viscosity	compute the density and viscosity of the fluid
compute_internal_energy	compute the fluid internal energy
compute_enthalpy	compute the fluid enthalpy
at_nodes	add a nodal material

Definition at line 453 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_material")
  {
    std::string material_type = "PorousFlowBrine";
    InputParameters params = _factory.getValidParams(material_type);
 
    params.set<std::vector<VariableName>>("xnacl") = {nacl_brine};
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<unsigned int>("phase") = phase;
    params.set<bool>("compute_density_and_viscosity") = compute_density_and_viscosity;
    params.set<bool>("compute_internal_energy") = compute_internal_energy;
    params.set<bool>("compute_enthalpy") = compute_enthalpy;
 
    std::string material_name = "PorousFlowActionBase_FluidProperties_qp";
    if (at_nodes)
      material_name = "PorousFlowActionBase_FluidProperties";
 
    params.set<bool>("at_nodes") = at_nodes;
    _problem->addMaterial(material_type, material_name, params);
  }
}

Referenced by PorousFlowSinglePhaseBase::addMaterials().

addCapillaryPressureVG()

void PorousFlowActionBase::addCapillaryPressureVG ( Real  m, Real  alpha, std::string  userobject_name  )

protectedinherited

Adds a van Genuchten capillary pressure UserObject.

Parameters

m	van Genuchten exponent
alpha	van Genuchten alpha
userobject_name	name of the user object

Definition at line 531 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_user_object")
  {
    std::string userobject_type = "PorousFlowCapillaryPressureVG";
    InputParameters params = _factory.getValidParams(userobject_type);
    params.set<Real>("m") = m;
    params.set<Real>("alpha") = alpha;
    _problem->addUserObject(userobject_type, userobject_name, params);
  }
}

Referenced by addUserObjects().

addDarcyAux()

void PorousFlowActionBase::addDarcyAux ( const RealVectorValue &  gravity )

protectedinherited

Add AuxVariables and AuxKernels to calculate Darcy velocity.

Parameters

gravity

gravitational acceleration pointing downwards (eg (0, 0, -9.8))

Definition at line 220 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_aux_variable")
  {
    auto var_params = _factory.getValidParams("MooseVariableConstMonomial");
 
    _problem->addAuxVariable("MooseVariableConstMonomial", "darcy_vel_x", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "darcy_vel_y", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "darcy_vel_z", var_params);
  }
 
  if (_current_task == "add_aux_kernel")
  {
    std::string aux_kernel_type = "PorousFlowDarcyVelocityComponent";
    InputParameters params = _factory.getValidParams(aux_kernel_type);
 
    params.set<RealVectorValue>("gravity") = gravity;
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
 
    std::string aux_kernel_name = "PorousFlowActionBase_Darcy_x_Aux";
    params.set<MooseEnum>("component") = "x";
    params.set<AuxVariableName>("variable") = "darcy_vel_x";
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowActionBase_Darcy_y_Aux";
    params.set<MooseEnum>("component") = "y";
    params.set<AuxVariableName>("variable") = "darcy_vel_y";
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowActionBase_Darcy_z_Aux";
    params.set<MooseEnum>("component") = "z";
    params.set<AuxVariableName>("variable") = "darcy_vel_z";
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
  }
}

Referenced by PorousFlowSinglePhaseBase::addAuxObjects().

addDictator()

void PorousFlowSinglePhaseBase::addDictator ( )

overrideprotectedvirtualinherited

Add the PorousFlowDictator object.

Implements PorousFlowActionBase.

Definition at line 277 of file PorousFlowSinglePhaseBase.C.

{
  const std::string uo_name = _dictator_name;
  const std::string uo_type = "PorousFlowDictator";
  InputParameters params = _factory.getValidParams(uo_type);
  std::vector<VariableName> pf_vars = _mass_fraction_vars;
  pf_vars.push_back(_pp_var);
  if (_thermal)
    pf_vars.push_back(_temperature_var[0]);
  if (_mechanical)
    pf_vars.insert(pf_vars.end(), _coupled_displacements.begin(), _coupled_displacements.end());
  params.set<std::vector<VariableName>>("porous_flow_vars") = pf_vars;
  params.set<unsigned int>("number_fluid_phases") = 1;
  params.set<unsigned int>("number_fluid_components") = _num_mass_fraction_vars + 1;
  params.set<unsigned int>("number_aqueous_equilibrium") = _num_aqueous_equilibrium;
  params.set<unsigned int>("number_aqueous_kinetic") = _num_aqueous_kinetic;
  _problem->addUserObject(uo_type, uo_name, params);
}

addEffectiveFluidPressureMaterial()

void PorousFlowActionBase::addEffectiveFluidPressureMaterial ( bool  at_nodes )

protectedinherited

Adds a nodal and a quadpoint effective fluid pressure material.

Parameters

at_nodes

Add nodal effective fluid pressure material

Definition at line 388 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_material")
  {
    std::string material_type = "PorousFlowEffectiveFluidPressure";
    InputParameters params = _factory.getValidParams(material_type);
 
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
 
    std::string material_name = "PorousFlowUnsaturated_EffectiveFluidPressure_qp";
    if (at_nodes)
      material_name = "PorousFlowUnsaturated_EffectiveFluidPressure";
 
    params.set<bool>("at_nodes") = at_nodes;
    _problem->addMaterial(material_type, material_name, params);
  }
}

Referenced by PorousFlowSinglePhaseBase::addMaterials().

addKernels()

void PorousFlowUnsaturated::addKernels ( )

overrideprotectedvirtual

Add all Kernels.

Reimplemented from PorousFlowSinglePhaseBase.

Definition at line 109 of file PorousFlowUnsaturated.C.

{
  PorousFlowSinglePhaseBase::addKernels();
 
  // add the kernels
  if (_stabilization == StabilizationEnum::Full)
  {
    const std::string kernel_type = "PorousFlowAdvectiveFlux";
    InputParameters params = _factory.getValidParams(kernel_type);
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<RealVectorValue>("gravity") = _gravity;
 
    for (unsigned i = 0; i < _num_mass_fraction_vars; ++i)
    {
      const std::string kernel_name = "PorousFlowUnsaturated_AdvectiveFlux" + Moose::stringify(i);
      params.set<unsigned int>("fluid_component") = i;
      params.set<NonlinearVariableName>("variable") = _mass_fraction_vars[i];
      _problem->addKernel(kernel_type, kernel_name, params);
    }
    const std::string kernel_name =
        "PorousFlowUnsaturated_AdvectiveFlux" + Moose::stringify(_num_mass_fraction_vars);
    params.set<unsigned int>("fluid_component") = _num_mass_fraction_vars;
    params.set<NonlinearVariableName>("variable") = _pp_var;
    _problem->addKernel(kernel_type, kernel_name, params);
  }
  else if (_stabilization == StabilizationEnum::KT)
  {
    const std::string kernel_type = "PorousFlowFluxLimitedTVDAdvection";
    InputParameters params = _factory.getValidParams(kernel_type);
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
 
    for (unsigned i = 0; i < _num_mass_fraction_vars; ++i)
    {
      const std::string kernel_name = "PorousFlowFluxLimited_DarcyFlow" + Moose::stringify(i);
      params.set<UserObjectName>("advective_flux_calculator") =
          "PorousFlowUnsaturated_AC_" + Moose::stringify(i);
      params.set<NonlinearVariableName>("variable") = _mass_fraction_vars[i];
      _problem->addKernel(kernel_type, kernel_name, params);
    }
    const std::string kernel_name =
        "PorousFlowFluxLimited_DarcyFlow" + Moose::stringify(_num_mass_fraction_vars);
    params.set<NonlinearVariableName>("variable") = _pp_var;
    params.set<UserObjectName>("advective_flux_calculator") =
        "PorousFlowUnsaturated_AC_" + Moose::stringify(_num_mass_fraction_vars);
    _problem->addKernel(kernel_type, kernel_name, params);
  }
 
  if (_transient)
  {
    std::string kernel_name = "PorousFlowUnsaturated_MassTimeDerivative";
    std::string kernel_type = "PorousFlowMassTimeDerivative";
    InputParameters params = _factory.getValidParams(kernel_type);
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
 
    for (unsigned i = 0; i < _num_mass_fraction_vars; ++i)
    {
      kernel_name = "PorousFlowUnsaturated_MassTimeDerivative" + Moose::stringify(i);
      params.set<unsigned int>("fluid_component") = i;
      params.set<NonlinearVariableName>("variable") = _mass_fraction_vars[i];
      _problem->addKernel(kernel_type, kernel_name, params);
    }
    kernel_name =
        "PorousFlowUnsaturated_MassTimeDerivative" + Moose::stringify(_num_mass_fraction_vars);
    params.set<unsigned int>("fluid_component") = _num_mass_fraction_vars;
    params.set<NonlinearVariableName>("variable") = _pp_var;
    _problem->addKernel(kernel_type, kernel_name, params);
  }
 
  if (_mechanical && _transient)
  {
    std::string kernel_name = "PorousFlowUnsaturated_MassVolumetricExpansion";
    std::string kernel_type = "PorousFlowMassVolumetricExpansion";
    InputParameters params = _factory.getValidParams(kernel_type);
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
 
    for (unsigned i = 0; i < _num_mass_fraction_vars; ++i)
    {
      kernel_name = "PorousFlowUnsaturated_MassVolumetricExpansion" + Moose::stringify(i);
      params.set<unsigned>("fluid_component") = i;
      params.set<NonlinearVariableName>("variable") = _mass_fraction_vars[i];
      _problem->addKernel(kernel_type, kernel_name, params);
    }
    kernel_name =
        "PorousFlowUnsaturated_MassVolumetricExpansion" + Moose::stringify(_num_mass_fraction_vars);
    params.set<unsigned>("fluid_component") = _num_mass_fraction_vars;
    params.set<NonlinearVariableName>("variable") = _pp_var;
    _problem->addKernel(kernel_type, kernel_name, params);
  }
 
  if (_thermal)
  {
    if (_stabilization == StabilizationEnum::Full)
    {
      const std::string kernel_name = "PorousFlowUnsaturated_HeatAdvection";
      const std::string kernel_type = "PorousFlowHeatAdvection";
      InputParameters params = _factory.getValidParams(kernel_type);
      params.set<NonlinearVariableName>("variable") = _temperature_var[0];
      params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
      params.set<RealVectorValue>("gravity") = _gravity;
      _problem->addKernel(kernel_type, kernel_name, params);
    }
    else if (_stabilization == StabilizationEnum::KT)
    {
      const std::string kernel_name = "PorousFlowUnsaturated_HeatAdvection";
      const std::string kernel_type = "PorousFlowFluxLimitedTVDAdvection";
      InputParameters params = _factory.getValidParams(kernel_type);
      params.set<NonlinearVariableName>("variable") = _temperature_var[0];
      params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
      params.set<UserObjectName>("advective_flux_calculator") = "PorousFlowUnsaturatedHeat_AC";
      _problem->addKernel(kernel_type, kernel_name, params);
    }
  }
}

addMassFractionMaterial()

void PorousFlowActionBase::addMassFractionMaterial ( bool  at_nodes )

protectedinherited

Adds a nodal and a quadpoint MassFraction material.

Parameters

at_nodes

Add nodal mass-fraction material

Definition at line 363 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_material")
  {
    if (!(parameters().hasDefaultCoupledValue("mass_fraction_vars") ||
          parameters().hasCoupledValue("mass_fraction_vars")))
      mooseError("Attempt to add a PorousFlowMassFraction material without setting the "
                 "mass_fraction_vars");
 
    std::string material_type = "PorousFlowMassFraction";
    InputParameters params = _factory.getValidParams(material_type);
 
    params.applySpecificParameters(parameters(), {"mass_fraction_vars"});
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
 
    std::string material_name = "PorousFlowActionBase_MassFraction_qp";
    if (at_nodes)
      material_name = "PorousFlowActionBase_MassFraction";
 
    params.set<bool>("at_nodes") = at_nodes;
    _problem->addMaterial(material_type, material_name, params);
  }
}

Referenced by PorousFlowSinglePhaseBase::addMaterials().

addMaterialDependencies()

void PorousFlowUnsaturated::addMaterialDependencies ( )

overrideprotectedvirtual

Add all material dependencies so that the correct version of each material can be added.

Reimplemented from PorousFlowSinglePhaseBase.

Definition at line 82 of file PorousFlowUnsaturated.C.

{
  PorousFlowSinglePhaseBase::addMaterialDependencies();
 
  // Add necessary objects to list of PorousFlow objects added by this action
  _included_objects.push_back("PorousFlowAdvectiveFlux");
 
  if (_transient)
    _included_objects.push_back("PorousFlowMassTimeDerivative");
 
  if (_mechanical && _transient)
    _included_objects.push_back("PorousFlowMassVolumetricExpansion");
 
  if (_thermal)
    _included_objects.push_back("PorousFlowHeatAdvection");
 
  if (_add_saturation_aux)
    _included_objects.push_back("SaturationAux");
 
  if (_stabilization == StabilizationEnum::KT)
    _included_objects.push_back("PorousFlowAdvectiveFluxCalculatorUnsaturatedMultiComponent");
 
  if (_stabilization == StabilizationEnum::KT && _thermal)
    _included_objects.push_back("PorousFlowAdvectiveFluxCalculatorUnsaturatedHeat");
}

addMaterials()

void PorousFlowUnsaturated::addMaterials ( )

overrideprotectedvirtual

Add all Materials.

Reimplemented from PorousFlowSinglePhaseBase.

Definition at line 256 of file PorousFlowUnsaturated.C.

{
  PorousFlowSinglePhaseBase::addMaterials();
 
  if (_deps.dependsOn(_included_objects, "pressure_saturation_qp"))
  {
    const std::string material_type = "PorousFlow1PhaseP";
    InputParameters params = _factory.getValidParams(material_type);
    const std::string material_name = "PorousFlowUnsaturated_1PhaseP_VG_qp";
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<std::vector<VariableName>>("porepressure") = {_pp_var};
    params.set<UserObjectName>("capillary_pressure") = _capillary_pressure_name;
    params.set<bool>("at_nodes") = false;
    _problem->addMaterial(material_type, material_name, params);
  }
  if (_deps.dependsOn(_included_objects, "pressure_saturation_nodal"))
  {
    const std::string material_type = "PorousFlow1PhaseP";
    InputParameters params = _factory.getValidParams(material_type);
    const std::string material_name = "PorousFlowUnsaturated_1PhaseP_VG_nodal";
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<std::vector<VariableName>>("porepressure") = {_pp_var};
    params.set<UserObjectName>("capillary_pressure") = _capillary_pressure_name;
    params.set<bool>("at_nodes") = true;
    _problem->addMaterial(material_type, material_name, params);
  }
 
  if (_deps.dependsOn(_included_objects, "relative_permeability_qp"))
  {
    if (_relperm_type == RelpermTypeChoiceEnum::FLAC)
      addRelativePermeabilityFLAC(false, 0, _relative_permeability_exponent, _s_res, _s_res);
    else
      addRelativePermeabilityCorey(false, 0, _relative_permeability_exponent, _s_res, _s_res);
  }
 
  if (_deps.dependsOn(_included_objects, "relative_permeability_nodal"))
  {
    if (_relperm_type == RelpermTypeChoiceEnum::FLAC)
      addRelativePermeabilityFLAC(true, 0, _relative_permeability_exponent, _s_res, _s_res);
    else
      addRelativePermeabilityCorey(true, 0, _relative_permeability_exponent, _s_res, _s_res);
  }
 
  if (_deps.dependsOn(_included_objects, "volumetric_strain_qp") ||
      _deps.dependsOn(_included_objects, "volumetric_strain_nodal"))
    addVolumetricStrainMaterial(_coupled_displacements, true);
}

addRelationshipManagers()

void PorousFlowActionBase::addRelationshipManagers ( Moose::RelationshipManagerType  when_type )

overridevirtualinherited

Definition at line 106 of file PorousFlowActionBase.C.

{
  InputParameters ips = (_stabilization == StabilizationEnum::KT
                             ? _factory.getValidParams("PorousFlowAdvectiveFluxCalculatorSaturated")
                             : emptyInputParameters());
  addRelationshipManagers(input_rm_type, ips);
}

addRelativePermeabilityCorey()

void PorousFlowActionBase::addRelativePermeabilityCorey ( bool  at_nodes, unsigned  phase, Real  n, Real  s_res, Real  sum_s_res  )

protectedinherited

Adds a relative-permeability Material of the Corey variety.

Parameters

phase	the phase number of the fluid
n	The Corey exponent
s_res	The residual saturation for this phase
sum_s_res	The sum of residual saturations over all phases

Definition at line 482 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_material")
  {
    std::string material_type = "PorousFlowRelativePermeabilityCorey";
    InputParameters params = _factory.getValidParams(material_type);
 
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<Real>("n") = n;
    params.set<unsigned int>("phase") = phase;
    params.set<Real>("s_res") = s_res;
    params.set<Real>("sum_s_res") = sum_s_res;
 
    std::string material_name = "PorousFlowActionBase_RelativePermeability_qp";
    if (at_nodes)
      material_name = "PorousFlowActionBase_RelativePermeability_nodal";
 
    params.set<bool>("at_nodes") = at_nodes;
    _problem->addMaterial(material_type, material_name, params);
  }
}

Referenced by PorousFlowFullySaturated::addMaterials(), addMaterials(), and PorousFlowBasicTHM::addMaterials().

addRelativePermeabilityFLAC()

void PorousFlowActionBase::addRelativePermeabilityFLAC ( bool  at_nodes, unsigned  phase, Real  m, Real  s_res, Real  sum_s_res  )

protectedinherited

Adds a relative-permeability Material of the FLAC variety.

Parameters

phase	the phase number of the fluid
m	The FLAC exponent
s_res	The residual saturation for this phase
sum_s_res	The sum of residual saturations over all phases

Definition at line 507 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_material")
  {
    std::string material_type = "PorousFlowRelativePermeabilityFLAC";
    InputParameters params = _factory.getValidParams(material_type);
 
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<Real>("m") = m;
    params.set<unsigned int>("phase") = phase;
    params.set<Real>("s_res") = s_res;
    params.set<Real>("sum_s_res") = sum_s_res;
 
    std::string material_name = "PorousFlowActionBase_RelativePermeability_qp";
    if (at_nodes)
      material_name = "PorousFlowActionBase_RelativePermeability_nodal";
 
    params.set<bool>("at_nodes") = at_nodes;
    _problem->addMaterial(material_type, material_name, params);
  }
}

Referenced by addMaterials().

addSaturationAux()

void PorousFlowActionBase::addSaturationAux ( unsigned  phase )

protectedinherited

Add an AuxVariable and AuxKernel to calculate saturation.

Parameters

phase

Saturation for this fluid phase

Definition at line 195 of file PorousFlowActionBase.C.

{
  std::string phase_str = Moose::stringify(phase);
 
  if (_current_task == "add_aux_variable")
  {
    auto var_params = _factory.getValidParams("MooseVariableConstMonomial");
    _problem->addAuxVariable("MooseVariableConstMonomial", "saturation" + phase_str, var_params);
  }
 
  if (_current_task == "add_aux_kernel")
  {
    std::string aux_kernel_type = "MaterialStdVectorAux";
    InputParameters params = _factory.getValidParams(aux_kernel_type);
 
    std::string aux_kernel_name = "PorousFlowActionBase_SaturationAux" + phase_str;
    params.set<MaterialPropertyName>("property") = "PorousFlow_saturation_qp";
    params.set<unsigned>("index") = phase;
    params.set<AuxVariableName>("variable") = "saturation" + phase_str;
    params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
  }
}

Referenced by addAuxObjects().

addSingleComponentFluidMaterial()

void PorousFlowActionBase::addSingleComponentFluidMaterial ( bool  at_nodes, unsigned  phase, bool  compute_density_and_viscosity, bool  compute_internal_energy, bool  compute_enthalpy, const UserObjectName &  fp  )

protectedinherited

Adds a single-component fluid Material.

Parameters

phase	the phase number of the fluid
fp	the name of the FluidProperties UserObject
compute_density_and_viscosity	compute the density and viscosity of the fluid
compute_internal_energy	compute the fluid internal energy
compute_enthalpy	compute the fluid enthalpy
at_nodes	add a nodal material

Definition at line 424 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_material")
  {
    std::string material_type = "PorousFlowSingleComponentFluid";
    InputParameters params = _factory.getValidParams(material_type);
 
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<unsigned int>("phase") = phase;
    params.set<bool>("compute_density_and_viscosity") = compute_density_and_viscosity;
    params.set<bool>("compute_internal_energy") = compute_internal_energy;
    params.set<bool>("compute_enthalpy") = compute_enthalpy;
    params.set<UserObjectName>("fp") = fp;
 
    std::string material_name = "PorousFlowActionBase_FluidProperties_qp";
    if (at_nodes)
      material_name = "PorousFlowActionBase_FluidProperties";
 
    params.set<bool>("at_nodes") = at_nodes;
    _problem->addMaterial(material_type, material_name, params);
  }
}

Referenced by PorousFlowSinglePhaseBase::addMaterials().

addStressAux()

void PorousFlowActionBase::addStressAux ( )

protectedinherited

Add AuxVariables and AuxKernels to compute effective stress.

Definition at line 258 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_aux_variable")
  {
    auto var_params = _factory.getValidParams("MooseVariableConstMonomial");
    _problem->addAuxVariable("MooseVariableConstMonomial", "stress_xx", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "stress_xy", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "stress_xz", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "stress_yx", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "stress_yy", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "stress_yz", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "stress_zx", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "stress_zy", var_params);
    _problem->addAuxVariable("MooseVariableConstMonomial", "stress_zz", var_params);
  }
 
  if (_current_task == "add_aux_kernel")
  {
    std::string aux_kernel_type = "RankTwoAux";
    InputParameters params = _factory.getValidParams(aux_kernel_type);
 
    params.set<MaterialPropertyName>("rank_two_tensor") = "stress";
    params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
 
    std::string aux_kernel_name = "PorousFlowAction_stress_xx";
    params.set<AuxVariableName>("variable") = "stress_xx";
    params.set<unsigned>("index_i") = 0;
    params.set<unsigned>("index_j") = 0;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowAction_stress_xy";
    params.set<AuxVariableName>("variable") = "stress_xy";
    params.set<unsigned>("index_i") = 0;
    params.set<unsigned>("index_j") = 1;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowAction_stress_xz";
    params.set<AuxVariableName>("variable") = "stress_xz";
    params.set<unsigned>("index_i") = 0;
    params.set<unsigned>("index_j") = 2;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowAction_stress_yx";
    params.set<AuxVariableName>("variable") = "stress_yx";
    params.set<unsigned>("index_i") = 1;
    params.set<unsigned>("index_j") = 0;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowAction_stress_yy";
    params.set<AuxVariableName>("variable") = "stress_yy";
    params.set<unsigned>("index_i") = 1;
    params.set<unsigned>("index_j") = 1;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowAction_stress_yz";
    params.set<AuxVariableName>("variable") = "stress_yz";
    params.set<unsigned>("index_i") = 1;
    params.set<unsigned>("index_j") = 2;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowAction_stress_zx";
    params.set<AuxVariableName>("variable") = "stress_zx";
    params.set<unsigned>("index_i") = 2;
    params.set<unsigned>("index_j") = 0;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowAction_stress_zy";
    params.set<AuxVariableName>("variable") = "stress_zy";
    params.set<unsigned>("index_i") = 2;
    params.set<unsigned>("index_j") = 1;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
 
    aux_kernel_name = "PorousFlowAction_stress_zz";
    params.set<AuxVariableName>("variable") = "stress_zz";
    params.set<unsigned>("index_i") = 2;
    params.set<unsigned>("index_j") = 2;
    _problem->addAuxKernel(aux_kernel_type, aux_kernel_name, params);
  }
}

Referenced by PorousFlowSinglePhaseBase::addAuxObjects().

addTemperatureMaterial()

void PorousFlowActionBase::addTemperatureMaterial ( bool  at_nodes )

protectedinherited

Adds a nodal and a quadpoint Temperature material.

Parameters

at_nodes

Add nodal temperature Material

Definition at line 339 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_material")
  {
    if (!parameters().hasDefaultCoupledValue("temperature"))
      mooseError("Attempt to add a PorousFlowTemperature material without setting a temperature "
                 "variable");
 
    std::string material_type = "PorousFlowTemperature";
    InputParameters params = _factory.getValidParams(material_type);
 
    params.applySpecificParameters(parameters(), {"temperature"});
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
 
    std::string material_name = "PorousFlowActionBase_Temperature_qp";
    if (at_nodes)
      material_name = "PorousFlowActionBase_Temperature";
 
    params.set<bool>("at_nodes") = at_nodes;
    _problem->addMaterial(material_type, material_name, params);
  }
}

Referenced by PorousFlowSinglePhaseBase::addMaterials().

addUserObjects()

void PorousFlowUnsaturated::addUserObjects ( )

overrideprotectedvirtual

Add all other UserObjects.

Reimplemented from PorousFlowActionBase.

Definition at line 224 of file PorousFlowUnsaturated.C.

{
  PorousFlowSinglePhaseBase::addUserObjects();
 
  // Add the capillary pressure UserObject
  addCapillaryPressureVG(_van_genuchten_m, _van_genuchten_alpha, _capillary_pressure_name);
 
  // add Advective Flux calculator UserObjects, if required
  if (_stabilization == StabilizationEnum::KT)
  {
    for (unsigned i = 0; i < _num_mass_fraction_vars; ++i)
    {
      const std::string userobject_name = "PorousFlowUnsaturated_AC_" + Moose::stringify(i);
      addAdvectiveFluxCalculatorUnsaturatedMultiComponent(0, i, true, userobject_name);
    }
    const std::string userobject_name =
        "PorousFlowUnsaturated_AC_" + Moose::stringify(_num_mass_fraction_vars);
    if (_num_mass_fraction_vars == 0)
      addAdvectiveFluxCalculatorUnsaturated(0, true, userobject_name); // 1 component only
    else
      addAdvectiveFluxCalculatorUnsaturatedMultiComponent(
          0, _num_mass_fraction_vars, true, userobject_name);
 
    if (_thermal)
    {
      const std::string userobject_name = "PorousFlowUnsaturatedHeat_AC";
      addAdvectiveFluxCalculatorUnsaturatedHeat(0, true, userobject_name);
    }
  }
}

addVolumetricStrainMaterial()

void PorousFlowActionBase::addVolumetricStrainMaterial ( const std::vector< VariableName > &  displacements, bool  consistent_with_displaced_mesh  )

protectedinherited

Adds a quadpoint volumetric strain material.

Parameters

displacements	the names of the displacement variables
consistent_with_displaced_mesh	The volumetric strain should be consistent with the displaced mesh

Definition at line 407 of file PorousFlowActionBase.C.

{
  if (_current_task == "add_material")
  {
    std::string material_type = "PorousFlowVolumetricStrain";
    InputParameters params = _factory.getValidParams(material_type);
 
    std::string material_name = "PorousFlowActionBase_VolumetricStrain";
    params.set<UserObjectName>("PorousFlowDictator") = _dictator_name;
    params.set<std::vector<VariableName>>("displacements") = displacements;
    params.set<bool>("consistent_with_displaced_mesh") = consistent_with_displaced_mesh;
    _problem->addMaterial(material_type, material_name, params);
  }
}

Referenced by PorousFlowFullySaturated::addMaterials(), addMaterials(), and PorousFlowBasicTHM::addMaterials().

Member Data Documentation

_add_darcy_aux

const bool PorousFlowSinglePhaseBase::_add_darcy_aux

protectedinherited

Add a AuxVariables to record Darcy velocity.

Definition at line 56 of file PorousFlowSinglePhaseBase.h.

Referenced by PorousFlowSinglePhaseBase::addAuxObjects(), and PorousFlowSinglePhaseBase::addMaterialDependencies().

_add_saturation_aux

const bool PorousFlowUnsaturated::_add_saturation_aux

protected

Add an Aux Variable to record saturation.

Definition at line 37 of file PorousFlowUnsaturated.h.

Referenced by addAuxObjects(), and addMaterialDependencies().

_add_stress_aux

const bool PorousFlowSinglePhaseBase::_add_stress_aux

protectedinherited

Add AuxVariables for stress.

Definition at line 59 of file PorousFlowSinglePhaseBase.h.

Referenced by PorousFlowSinglePhaseBase::addAuxObjects(), and PorousFlowSinglePhaseBase::addMaterialDependencies().

_biot_coefficient

const Real PorousFlowSinglePhaseBase::_biot_coefficient

protectedinherited

Fluid specific heat capacity at constant volume.

Definition at line 53 of file PorousFlowSinglePhaseBase.h.

Referenced by PorousFlowSinglePhaseBase::addKernels(), and PorousFlowBasicTHM::addKernels().

_capillary_pressure_name

const std::string PorousFlowUnsaturated::_capillary_pressure_name

protected

Name of the capillary pressure UserObject.

Definition at line 55 of file PorousFlowUnsaturated.h.

Referenced by addMaterials(), and addUserObjects().

_coord_system

Moose::CoordinateSystemType PorousFlowActionBase::_coord_system

protectedinherited

Coordinate system of the simulation (eg RZ, XYZ, etc)

Definition at line 89 of file PorousFlowActionBase.h.

Referenced by PorousFlowActionBase::act(), and PorousFlowSinglePhaseBase::addKernels().

_coupled_displacements

std::vector<VariableName> PorousFlowActionBase::_coupled_displacements

protectedinherited

Displacement Variable names.

Definition at line 81 of file PorousFlowActionBase.h.

Referenced by PorousFlowSinglePhaseBase::addDictator(), PorousFlowSinglePhaseBase::addKernels(), PorousFlowFullySaturated::addMaterials(), addMaterials(), PorousFlowBasicTHM::addMaterials(), and PorousFlowActionBase::PorousFlowActionBase().

_coupling_type

enum PorousFlowSinglePhaseBase::CouplingTypeEnum PorousFlowSinglePhaseBase::_coupling_type

protectedinherited

_deps

DependencyResolver<std::string> PorousFlowDependencies::_deps

protectedinherited

All dependencies of kernels, auxkernels, materials, etc, are stored in _dependencies.

Definition at line 37 of file PorousFlowDependencies.h.

Referenced by PorousFlowFullySaturated::addMaterials(), PorousFlowSinglePhaseBase::addMaterials(), addMaterials(), PorousFlowBasicTHM::addMaterials(), PorousFlowAddMaterialAction::isPFMaterialRequired(), and PorousFlowDependencies::PorousFlowDependencies().

_dictator_name

const std::string PorousFlowActionBase::_dictator_name

protectedinherited

The name of the PorousFlowDictator object to be added.

Definition at line 54 of file PorousFlowActionBase.h.

Referenced by PorousFlowActionBase::addAdvectiveFluxCalculatorSaturated(), PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedHeat(), PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedMultiComponent(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturated(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedHeat(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedMultiComponent(), PorousFlowActionBase::addBrineMaterial(), PorousFlowActionBase::addDarcyAux(), PorousFlowSinglePhaseBase::addDictator(), PorousFlowActionBase::addEffectiveFluidPressureMaterial(), PorousFlowFullySaturated::addKernels(), PorousFlowSinglePhaseBase::addKernels(), addKernels(), PorousFlowBasicTHM::addKernels(), PorousFlowActionBase::addMassFractionMaterial(), PorousFlowFullySaturated::addMaterials(), PorousFlowBasicTHM::addMaterials(), addMaterials(), PorousFlowActionBase::addRelativePermeabilityCorey(), PorousFlowActionBase::addRelativePermeabilityFLAC(), PorousFlowActionBase::addSingleComponentFluidMaterial(), PorousFlowActionBase::addTemperatureMaterial(), and PorousFlowActionBase::addVolumetricStrainMaterial().

_displacements

const std::vector<VariableName>& PorousFlowActionBase::_displacements

protectedinherited

Displacement NonlinearVariable names (if any)

Definition at line 75 of file PorousFlowActionBase.h.

Referenced by PorousFlowSinglePhaseBase::addKernels(), and PorousFlowActionBase::PorousFlowActionBase().

_flux_limiter_type

const MooseEnum PorousFlowActionBase::_flux_limiter_type

protectedinherited

Flux limiter type in the Kuzmin-Turek FEM-TVD stabilization scheme.

Definition at line 84 of file PorousFlowActionBase.h.

Referenced by PorousFlowActionBase::addAdvectiveFluxCalculatorSaturated(), PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedHeat(), PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedMultiComponent(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturated(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedHeat(), and PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedMultiComponent().

_fp

const UserObjectName& PorousFlowSinglePhaseBase::_fp

protectedinherited

Name of the fluid-properties UserObject.

Definition at line 50 of file PorousFlowSinglePhaseBase.h.

Referenced by PorousFlowSinglePhaseBase::addMaterials(), and PorousFlowSinglePhaseBase::PorousFlowSinglePhaseBase().

_gravity

const RealVectorValue PorousFlowActionBase::_gravity

protectedinherited

Gravity.

Definition at line 63 of file PorousFlowActionBase.h.

Referenced by PorousFlowActionBase::addAdvectiveFluxCalculatorSaturated(), PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedHeat(), PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedMultiComponent(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturated(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedHeat(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedMultiComponent(), PorousFlowSinglePhaseBase::addAuxObjects(), PorousFlowFullySaturated::addKernels(), PorousFlowSinglePhaseBase::addKernels(), addKernels(), and PorousFlowBasicTHM::addKernels().

_included_objects

std::vector<std::string> PorousFlowActionBase::_included_objects

protectedinherited

List of Kernels, AuxKernels, Materials, etc, that are added in this input file.

This list will be used to determine what Materials need to be added. Actions may add or remove things from this list

Definition at line 51 of file PorousFlowActionBase.h.

Referenced by PorousFlowActionBase::act(), PorousFlowFullySaturated::addMaterialDependencies(), PorousFlowSinglePhaseBase::addMaterialDependencies(), addMaterialDependencies(), PorousFlowBasicTHM::addMaterialDependencies(), PorousFlowActionBase::addMaterialDependencies(), PorousFlowFullySaturated::addMaterials(), PorousFlowSinglePhaseBase::addMaterials(), PorousFlowBasicTHM::addMaterials(), and addMaterials().

_mass_fraction_vars

const std::vector<VariableName>& PorousFlowActionBase::_mass_fraction_vars

protectedinherited

Name of the mass-fraction variables (if any)

Definition at line 66 of file PorousFlowActionBase.h.

Referenced by PorousFlowSinglePhaseBase::addDictator(), PorousFlowFullySaturated::addKernels(), addKernels(), and PorousFlowSinglePhaseBase::addMaterials().

_mechanical

const bool PorousFlowSinglePhaseBase::_mechanical

protectedinherited

Definition at line 47 of file PorousFlowSinglePhaseBase.h.

Referenced by PorousFlowSinglePhaseBase::addAuxObjects(), PorousFlowSinglePhaseBase::addDictator(), PorousFlowFullySaturated::addKernels(), PorousFlowSinglePhaseBase::addKernels(), addKernels(), PorousFlowFullySaturated::addMaterialDependencies(), PorousFlowSinglePhaseBase::addMaterialDependencies(), addMaterialDependencies(), and PorousFlowBasicTHM::addMaterials().

_nacl_index

const unsigned PorousFlowSinglePhaseBase::_nacl_index

protectedinherited

Index of NaCl in list of fluid components.

Definition at line 65 of file PorousFlowSinglePhaseBase.h.

Referenced by PorousFlowSinglePhaseBase::addMaterials(), and PorousFlowSinglePhaseBase::PorousFlowSinglePhaseBase().

_ndisp

const unsigned PorousFlowActionBase::_ndisp

protectedinherited

Number of displacement variables supplied.

Definition at line 78 of file PorousFlowActionBase.h.

Referenced by PorousFlowSinglePhaseBase::addKernels(), and PorousFlowActionBase::PorousFlowActionBase().

_num_aqueous_equilibrium

const unsigned int PorousFlowActionBase::_num_aqueous_equilibrium

protectedinherited

Number of aqueous-equilibrium secondary species.

Definition at line 57 of file PorousFlowActionBase.h.

Referenced by PorousFlowSinglePhaseBase::addDictator().

_num_aqueous_kinetic

const unsigned int PorousFlowActionBase::_num_aqueous_kinetic

protectedinherited

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

Definition at line 60 of file PorousFlowActionBase.h.

Referenced by PorousFlowSinglePhaseBase::addDictator().

_num_mass_fraction_vars

const unsigned PorousFlowActionBase::_num_mass_fraction_vars

protectedinherited

Number of mass-fraction variables.

Definition at line 69 of file PorousFlowActionBase.h.

Referenced by PorousFlowSinglePhaseBase::addDictator(), PorousFlowFullySaturated::addKernels(), addKernels(), PorousFlowFullySaturated::addUserObjects(), addUserObjects(), PorousFlowBasicTHM::PorousFlowBasicTHM(), and PorousFlowSinglePhaseBase::PorousFlowSinglePhaseBase().

_pp_var

const VariableName PorousFlowSinglePhaseBase::_pp_var

protectedinherited

Porepressure NonlinearVariable name.

Definition at line 35 of file PorousFlowSinglePhaseBase.h.

Referenced by PorousFlowSinglePhaseBase::addDictator(), PorousFlowFullySaturated::addKernels(), addKernels(), PorousFlowBasicTHM::addKernels(), PorousFlowFullySaturated::addMaterials(), addMaterials(), and PorousFlowBasicTHM::addMaterials().

_relative_permeability_exponent

const Real PorousFlowUnsaturated::_relative_permeability_exponent

protected

Relative permeability exponent.

Definition at line 49 of file PorousFlowUnsaturated.h.

Referenced by addMaterials().

_relperm_type

enum PorousFlowUnsaturated::RelpermTypeChoiceEnum PorousFlowUnsaturated::_relperm_type

protected

Referenced by addMaterials().

_s_res

const Real PorousFlowUnsaturated::_s_res

protected

Residual saturation to use in the relative permeability expressions.

Definition at line 52 of file PorousFlowUnsaturated.h.

Referenced by addMaterials().

_stabilization

enum PorousFlowActionBase::StabilizationEnum PorousFlowActionBase::_stabilization

protectedinherited

Referenced by PorousFlowActionBase::addAdvectiveFluxCalculatorSaturated(), PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedHeat(), PorousFlowActionBase::addAdvectiveFluxCalculatorSaturatedMultiComponent(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturated(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedHeat(), PorousFlowActionBase::addAdvectiveFluxCalculatorUnsaturatedMultiComponent(), PorousFlowFullySaturated::addKernels(), addKernels(), PorousFlowFullySaturated::addMaterialDependencies(), addMaterialDependencies(), PorousFlowActionBase::addRelationshipManagers(), PorousFlowFullySaturated::addUserObjects(), and addUserObjects().

_temperature_var

const std::vector<VariableName>& PorousFlowActionBase::_temperature_var

protectedinherited

Name of the temperature variable (if any)

Definition at line 72 of file PorousFlowActionBase.h.

Referenced by PorousFlowSinglePhaseBase::addDictator(), PorousFlowFullySaturated::addKernels(), PorousFlowSinglePhaseBase::addKernels(), addKernels(), PorousFlowBasicTHM::addKernels(), and PorousFlowSinglePhaseBase::PorousFlowSinglePhaseBase().

_thermal

const bool PorousFlowSinglePhaseBase::_thermal

protectedinherited

Flags to indicate whether thermal or mechanical effects are included.

Definition at line 46 of file PorousFlowSinglePhaseBase.h.

Referenced by PorousFlowSinglePhaseBase::addDictator(), PorousFlowFullySaturated::addKernels(), PorousFlowSinglePhaseBase::addKernels(), addKernels(), PorousFlowBasicTHM::addKernels(), PorousFlowFullySaturated::addMaterialDependencies(), PorousFlowSinglePhaseBase::addMaterialDependencies(), addMaterialDependencies(), PorousFlowBasicTHM::addMaterialDependencies(), PorousFlowFullySaturated::addUserObjects(), addUserObjects(), and PorousFlowSinglePhaseBase::PorousFlowSinglePhaseBase().

_transient

bool PorousFlowActionBase::_transient

protectedinherited

Flag to denote if the simulation is transient.

Definition at line 92 of file PorousFlowActionBase.h.

Referenced by PorousFlowActionBase::act(), PorousFlowFullySaturated::addKernels(), PorousFlowSinglePhaseBase::addKernels(), addKernels(), PorousFlowBasicTHM::addKernels(), PorousFlowFullySaturated::addMaterialDependencies(), PorousFlowSinglePhaseBase::addMaterialDependencies(), PorousFlowBasicTHM::addMaterialDependencies(), and addMaterialDependencies().

_use_brine

const bool PorousFlowSinglePhaseBase::_use_brine

protectedinherited

Use PorousFlowBrine material.

Definition at line 62 of file PorousFlowSinglePhaseBase.h.

Referenced by PorousFlowSinglePhaseBase::addMaterials(), and PorousFlowSinglePhaseBase::PorousFlowSinglePhaseBase().

_van_genuchten_alpha

const Real PorousFlowUnsaturated::_van_genuchten_alpha

protected

Van Genuchten alpha parameter.

Definition at line 40 of file PorousFlowUnsaturated.h.

Referenced by addUserObjects().

_van_genuchten_m

const Real PorousFlowUnsaturated::_van_genuchten_m

protected

Van Genuchten m parameter.

Definition at line 43 of file PorousFlowUnsaturated.h.

Referenced by addUserObjects().

---

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

• porous_flow/include/actions/PorousFlowUnsaturated.h
• porous_flow/src/actions/PorousFlowUnsaturated.C