PorousFlowActionBase Class Reference

Base class for PorousFlow actions. More...

#include <PorousFlowActionBase.h>

Inheritance diagram for PorousFlowActionBase:

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

Protected Types
enum	StabilizationEnum { StabilizationEnum::Full, StabilizationEnum::KT }

Protected Member Functions
virtual void	addDictator ()=0
	Add the PorousFlowDictator object. More...
virtual void	addUserObjects ()
	Add all other UserObjects. More...
virtual void	addAuxObjects ()
	Add all AuxVariables and AuxKernels. More...
virtual void	addKernels ()
	Add all Kernels. More...
virtual void	addMaterialDependencies ()
	Add all material dependencies so that the correct version of each material can be added. More...
virtual void	addMaterials ()
	Add all Materials. 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
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

Base class for PorousFlow actions.

This act() method makes consistency checks and calls several methods that should be implemented in derived classes. This class also contains a number of utility functions that may be used by derived classes.

Derived classes should typically only override the following methods:

• addUserObjects()
• addMaterialDependencies()
• addMaterials()
• addAuxObjects()
• addKernels()

Definition at line 35 of file PorousFlowActionBase.h.

Member Enumeration Documentation

StabilizationEnum

enum PorousFlowActionBase::StabilizationEnum

strongprotected

Enumerator
Full
KT

Definition at line 86 of file PorousFlowActionBase.h.

{ Full, KT } _stabilization;

Constructor & Destructor Documentation

PorousFlowActionBase()

PorousFlowActionBase::PorousFlowActionBase

(

const InputParameters &

params

)

Definition at line 83 of file PorousFlowActionBase.C.

  : Action(params),
    PorousFlowDependencies(),
    _included_objects(),
    _dictator_name(getParam<std::string>("dictator_name")),
    _num_aqueous_equilibrium(getParam<unsigned int>("number_aqueous_equilibrium")),
    _num_aqueous_kinetic(getParam<unsigned int>("number_aqueous_kinetic")),
    _gravity(getParam<RealVectorValue>("gravity")),
    _mass_fraction_vars(getParam<std::vector<VariableName>>("mass_fraction_vars")),
    _num_mass_fraction_vars(_mass_fraction_vars.size()),
    _temperature_var(getParam<std::vector<VariableName>>("temperature")),
    _displacements(getParam<std::vector<VariableName>>("displacements")),
    _ndisp(_displacements.size()),
    _coupled_displacements(_ndisp),
    _flux_limiter_type(getParam<MooseEnum>("flux_limiter_type")),
    _stabilization(getParam<MooseEnum>("stabilization").getEnum<StabilizationEnum>())
{
  // convert vector of VariableName to vector of VariableName
  for (unsigned int i = 0; i < _ndisp; ++i)
    _coupled_displacements[i] = _displacements[i];
}

Member Function Documentation

act()

void PorousFlowActionBase::act ( )

overridevirtual

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  )

protected

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  )

protected

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  )

protected

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  )

protected

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 PorousFlowUnsaturated::addUserObjects().

addAdvectiveFluxCalculatorUnsaturatedHeat()

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

protected

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 PorousFlowUnsaturated::addUserObjects().

addAdvectiveFluxCalculatorUnsaturatedMultiComponent()

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

protected

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 PorousFlowUnsaturated::addUserObjects().

addAuxObjects()

void PorousFlowActionBase::addAuxObjects ( )

protectedvirtual

Add all AuxVariables and AuxKernels.

Reimplemented in PorousFlowUnsaturated, and PorousFlowSinglePhaseBase.

Definition at line 180 of file PorousFlowActionBase.C.

{
}

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

addBrineMaterial()

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

protected

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  )

protected

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 PorousFlowUnsaturated::addUserObjects().

addDarcyAux()

void PorousFlowActionBase::addDarcyAux ( const RealVectorValue &  gravity )

protected

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()

virtual void PorousFlowActionBase::addDictator ( )

protectedpure virtual

Add the PorousFlowDictator object.

Implemented in PorousFlowSinglePhaseBase.

Referenced by addUserObjects().

addEffectiveFluidPressureMaterial()

void PorousFlowActionBase::addEffectiveFluidPressureMaterial ( bool  at_nodes )

protected

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 PorousFlowActionBase::addKernels ( )

protectedvirtual

Add all Kernels.

Reimplemented in PorousFlowBasicTHM, PorousFlowUnsaturated, PorousFlowSinglePhaseBase, and PorousFlowFullySaturated.

Definition at line 185 of file PorousFlowActionBase.C.

{
}

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

addMassFractionMaterial()

void PorousFlowActionBase::addMassFractionMaterial ( bool  at_nodes )

protected

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 PorousFlowActionBase::addMaterialDependencies ( )

protectedvirtual

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

Reimplemented in PorousFlowBasicTHM, PorousFlowUnsaturated, PorousFlowSinglePhaseBase, and PorousFlowFullySaturated.

Definition at line 152 of file PorousFlowActionBase.C.

{
  // Check to see if there are any other PorousFlow objects like BCs that
  // may require specific versions of materials added using this action
 
  // Unique list of auxkernels added in input file
  auto auxkernels = _awh.getActions<AddKernelAction>();
  for (auto & auxkernel : auxkernels)
    _included_objects.push_back(auxkernel->getMooseObjectType());
 
  // Unique list of postprocessors added in input file
  auto postprocessors = _awh.getActions<AddPostprocessorAction>();
  for (auto & postprocessor : postprocessors)
    _included_objects.push_back(postprocessor->getMooseObjectType());
 
  // Unique list of BCs added in input file
  auto bcs = _awh.getActions<AddBCAction>();
  for (auto & bc : bcs)
    _included_objects.push_back(bc->getMooseObjectType());
}

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

addMaterials()

void PorousFlowActionBase::addMaterials ( )

protectedvirtual

Add all Materials.

Reimplemented in PorousFlowBasicTHM, PorousFlowUnsaturated, PorousFlowSinglePhaseBase, and PorousFlowFullySaturated.

Definition at line 190 of file PorousFlowActionBase.C.

{
}

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

addRelationshipManagers()

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

overridevirtual

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  )

protected

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(), PorousFlowUnsaturated::addMaterials(), and PorousFlowBasicTHM::addMaterials().

addRelativePermeabilityFLAC()

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

protected

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 PorousFlowUnsaturated::addMaterials().

addSaturationAux()

void PorousFlowActionBase::addSaturationAux ( unsigned  phase )

protected

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 PorousFlowUnsaturated::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  )

protected

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 ( )

protected

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 )

protected

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 PorousFlowActionBase::addUserObjects ( )

protectedvirtual

Add all other UserObjects.

Reimplemented in PorousFlowUnsaturated, and PorousFlowFullySaturated.

Definition at line 174 of file PorousFlowActionBase.C.

{
  addDictator();
}

Referenced by act(), PorousFlowFullySaturated::addUserObjects(), and PorousFlowUnsaturated::addUserObjects().

addVolumetricStrainMaterial()

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

protected

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(), PorousFlowUnsaturated::addMaterials(), and PorousFlowBasicTHM::addMaterials().

Member Data Documentation

_coord_system

Moose::CoordinateSystemType PorousFlowActionBase::_coord_system

protected

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

Definition at line 89 of file PorousFlowActionBase.h.

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

_coupled_displacements

std::vector<VariableName> PorousFlowActionBase::_coupled_displacements

protected

Displacement Variable names.

Definition at line 81 of file PorousFlowActionBase.h.

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

_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(), PorousFlowUnsaturated::addMaterials(), PorousFlowBasicTHM::addMaterials(), PorousFlowAddMaterialAction::isPFMaterialRequired(), and PorousFlowDependencies::PorousFlowDependencies().

_dictator_name

const std::string PorousFlowActionBase::_dictator_name

protected

The name of the PorousFlowDictator object to be added.

Definition at line 54 of file PorousFlowActionBase.h.

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

_displacements

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

protected

Displacement NonlinearVariable names (if any)

Definition at line 75 of file PorousFlowActionBase.h.

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

_flux_limiter_type

const MooseEnum PorousFlowActionBase::_flux_limiter_type

protected

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

Definition at line 84 of file PorousFlowActionBase.h.

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

_gravity

const RealVectorValue PorousFlowActionBase::_gravity

protected

Gravity.

Definition at line 63 of file PorousFlowActionBase.h.

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

_included_objects

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

protected

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 act(), PorousFlowFullySaturated::addMaterialDependencies(), PorousFlowSinglePhaseBase::addMaterialDependencies(), PorousFlowUnsaturated::addMaterialDependencies(), PorousFlowBasicTHM::addMaterialDependencies(), addMaterialDependencies(), PorousFlowFullySaturated::addMaterials(), PorousFlowSinglePhaseBase::addMaterials(), PorousFlowBasicTHM::addMaterials(), and PorousFlowUnsaturated::addMaterials().

_mass_fraction_vars

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

protected

Name of the mass-fraction variables (if any)

Definition at line 66 of file PorousFlowActionBase.h.

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

_ndisp

const unsigned PorousFlowActionBase::_ndisp

protected

Number of displacement variables supplied.

Definition at line 78 of file PorousFlowActionBase.h.

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

_num_aqueous_equilibrium

const unsigned int PorousFlowActionBase::_num_aqueous_equilibrium

protected

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

protected

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

protected

Number of mass-fraction variables.

Definition at line 69 of file PorousFlowActionBase.h.

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

_stabilization

enum PorousFlowActionBase::StabilizationEnum PorousFlowActionBase::_stabilization

protected

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

_temperature_var

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

protected

Name of the temperature variable (if any)

Definition at line 72 of file PorousFlowActionBase.h.

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

_transient

bool PorousFlowActionBase::_transient

protected

Flag to denote if the simulation is transient.

Definition at line 92 of file PorousFlowActionBase.h.

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

---

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

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