#include <PoroMechanicsAction.h>

Inheritance diagram for PoroMechanicsAction:

Public Member Functions
	PoroMechanicsAction (const InputParameters &params)

virtual void	act ()

Static Public Member Functions
static InputParameters	validParams ()

static MultiMooseEnum	outputPropertiesType ()

Static Public Attributes

static const std::map< std::string, std::string >	_ranktwoaux_table
	table data for output generation More...

static const std::vector< char >	_component_table = {'x', 'y', 'z'}

static const std::map< std::string, std::pair< std::string, std::vector< std::string > > >	_ranktwoscalaraux_table

Protected Types
enum	Strain { Strain::Small, Strain::Finite }
	strain formulation More...

enum	StrainAndIncrement { StrainAndIncrement::SmallTotal, StrainAndIncrement::FiniteTotal, StrainAndIncrement::SmallIncremental, StrainAndIncrement::FiniteIncremental }
	strain formulation More...

enum	PlanarFormulation { PlanarFormulation::None, PlanarFormulation::WeakPlaneStress, PlanarFormulation::PlaneStrain, PlanarFormulation::GeneralizedPlaneStrain }
	use an out of plane stress/strain formulation More...

enum	OutOfPlaneDirection { OutOfPlaneDirection::x, OutOfPlaneDirection::y, OutOfPlaneDirection::z }

Protected Member Functions
void	actSubdomainChecks ()

void	actOutputGeneration ()

void	actGatherActionParameters ()

virtual std::string	getKernelType ()

virtual InputParameters	getKernelParameters (std::string type)

Protected Attributes
Moose::CoordinateSystemType	_coord_system

std::vector< SubdomainName >	_subdomain_names
	if this vector is not empty the variables, kernels and materials are restricted to these subdomains More...

std::set< SubdomainID >	_subdomain_ids
	set generated from the passed in vector of subdomain names More...

std::set< SubdomainID >	_subdomain_id_union
	set generated from the combined block restrictions of all TensorMechanics/Master action blocks More...

enum TensorMechanicsAction::Strain	_strain

enum TensorMechanicsAction::StrainAndIncrement	_strain_and_increment

enum TensorMechanicsAction::PlanarFormulation	_planar_formulation

const OutOfPlaneDirection	_out_of_plane_direction

const std::string	_base_name
	base name for the current master action block More...

bool	_use_displaced_mesh
	use displaced mesh (true unless _strain is SMALL) More...

std::vector< std::string >	_generate_output
	output aux variables to generate for sclar stress/strain tensor quantities More...

const bool	_use_ad


std::vector< VariableName >	_displacements
	displacement variables More...

unsigned int	_ndisp

std::vector< VariableName >	_coupled_displacements


std::vector< AuxVariableName >	_save_in
	residual debugging More...

std::vector< AuxVariableName >	_diag_save_in

Detailed Description

Definition at line 19 of file PoroMechanicsAction.h.

Member Enumeration Documentation

◆ OutOfPlaneDirection

enum TensorMechanicsAction::OutOfPlaneDirection

strongprotectedinherited

Enumerator
x
y
z

Definition at line 83 of file TensorMechanicsAction.h.

   {
     x,
     y,
     z
   };

◆ PlanarFormulation

enum TensorMechanicsAction::PlanarFormulation

strongprotectedinherited

use an out of plane stress/strain formulation

Enumerator
None
WeakPlaneStress
PlaneStrain
GeneralizedPlaneStrain

Definition at line 75 of file TensorMechanicsAction.h.

   {
     None,
     WeakPlaneStress,
     PlaneStrain,
     GeneralizedPlaneStrain,
   } _planar_formulation;

◆ Strain

enum TensorMechanicsAction::Strain

strongprotectedinherited

strain formulation

Enumerator
Small
Finite

Definition at line 59 of file TensorMechanicsAction.h.

   {
     Small,
     Finite
   } _strain;

◆ StrainAndIncrement

enum TensorMechanicsAction::StrainAndIncrement

strongprotectedinherited

strain formulation

Enumerator
SmallTotal
FiniteTotal
SmallIncremental
FiniteIncremental

Definition at line 66 of file TensorMechanicsAction.h.

   {
     SmallTotal,
     FiniteTotal,
     SmallIncremental,
     FiniteIncremental
   } _strain_and_increment;

Constructor & Destructor Documentation

◆ PoroMechanicsAction()

PoroMechanicsAction::PoroMechanicsAction ( const InputParameters & params )

Definition at line 33 of file PoroMechanicsAction.C.

   : TensorMechanicsAction(params)
 {
   if (_use_ad)
     paramError("use_ad", "AD not setup for use with PoroMechanicsAction");
 }

Member Function Documentation

◆ act()

void PoroMechanicsAction::act ( )

virtual

Reimplemented from TensorMechanicsAction.

Definition at line 41 of file PoroMechanicsAction.C.

 {
   TensorMechanicsAction::act();
  
   if (_current_task == "add_kernel")
   {
     // Prepare displacements and set value for dim
     std::vector<VariableName> displacements = getParam<std::vector<VariableName>>("displacements");
     unsigned int dim = displacements.size();
  
     // all the kernels added below have pore pressure as a coupled variable
     // add this to the kernel's params
     std::string type("PoroMechanicsCoupling");
     InputParameters params = _factory.getValidParams(type);
     VariableName pp_var(getParam<VariableName>("porepressure"));
     params.addCoupledVar("porepressure", "");
     params.set<std::vector<VariableName>>("porepressure") = {pp_var};
  
     // now add the kernels
     for (unsigned int i = 0; i < dim; ++i)
     {
       std::string kernel_name = "PoroMechanics" + Moose::stringify(i);
  
       params.set<unsigned int>("component") = i;
       params.set<NonlinearVariableName>("variable") = displacements[i];
  
       _problem->addKernel(type, kernel_name, params);
     }
   }
 }

◆ actGatherActionParameters()

void TensorMechanicsAction::actGatherActionParameters ( )

protectedinherited

Definition at line 501 of file TensorMechanicsAction.C.

 {
   //
   // Gather info about all other master actions when we add variables
   //
   if (_current_task == "validate_coordinate_systems" && getParam<bool>("add_variables"))
   {
     auto actions = _awh.getActions<TensorMechanicsAction>();
     for (const auto & action : actions)
     {
       const auto size_before = _subdomain_id_union.size();
       const auto added_size = action->_subdomain_ids.size();
       _subdomain_id_union.insert(action->_subdomain_ids.begin(), action->_subdomain_ids.end());
       const auto size_after = _subdomain_id_union.size();
  
       if (size_after != size_before + added_size)
         mooseError("The block restrictions in the TensorMechanics/Master actions must be "
                    "non-overlapping.");
  
       if (added_size == 0 && actions.size() > 1)
         mooseError("No TensorMechanics/Master action can be block unrestricted if more than one "
                    "TensorMechanics/Master action is specified.");
     }
   }
 }

Referenced by TensorMechanicsAction::act().

◆ actOutputGeneration()

void TensorMechanicsAction::actOutputGeneration ( )

protectedinherited

Definition at line 427 of file TensorMechanicsAction.C.

 {
   //
   // Add variables (optional)
   //
   if (_current_task == "add_aux_variable")
   {
     auto params = _factory.getValidParams("MooseVariableConstMonomial");
     params.set<MooseEnum>("order") = "CONSTANT";
     params.set<MooseEnum>("family") = "MONOMIAL";
     // Loop through output aux variables
     for (auto out : _generate_output)
     {
       // Create output helper aux variables
       _problem->addAuxVariable("MooseVariableConstMonomial", _base_name + out, params);
     }
   }
  
   //
   // Add output AuxKernels
   //
   else if (_current_task == "add_aux_kernel")
   {
     // Loop through output aux variables
     for (auto out : _generate_output)
     {
       std::string type = "";
       InputParameters params = emptyInputParameters();
  
       // RankTwoAux
       for (const auto & r2a : _ranktwoaux_table)
         for (unsigned int a = 0; a < 3; ++a)
           for (unsigned int b = 0; b < 3; ++b)
             if (r2a.first + '_' + _component_table[a] + _component_table[b] == out)
             {
               type = "RankTwoAux";
               params = _factory.getValidParams(type);
               params.set<MaterialPropertyName>("rank_two_tensor") = _base_name + r2a.second;
               params.set<unsigned int>("index_i") = a;
               params.set<unsigned int>("index_j") = b;
             }
  
       // RankTwoScalarAux
       for (const auto & r2sa : _ranktwoscalaraux_table)
         for (const auto & t : r2sa.second.second)
           if (r2sa.first + '_' + t == out)
           {
             const auto r2a = _ranktwoaux_table.find(t);
             if (r2a != _ranktwoaux_table.end())
             {
               type = "RankTwoScalarAux";
               params = _factory.getValidParams(type);
               params.set<MaterialPropertyName>("rank_two_tensor") = _base_name + r2a->second;
               params.set<MooseEnum>("scalar_type") = r2sa.second.first;
             }
             else
               mooseError("Internal error. The permitted tensor shortcuts in "
                          "'_ranktwoscalaraux_table' must be keys in the '_ranktwoaux_table'.");
           }
  
       if (type != "")
       {
         params.applyParameters(parameters());
         params.set<AuxVariableName>("variable") = _base_name + out;
         params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
         _problem->addAuxKernel(type, _base_name + out + '_' + name(), params);
       }
       else
         mooseError("Unable to add output AuxKernel");
     }
   }
 }

Referenced by TensorMechanicsAction::act().

◆ actSubdomainChecks()

void TensorMechanicsAction::actSubdomainChecks ( )

protectedinherited

Definition at line 382 of file TensorMechanicsAction.C.

 {
   //
   // Do the coordinate system check only once the problem is created
   //
   if (_current_task == "setup_mesh_complete")
   {
     // get subdomain IDs
     for (auto & name : _subdomain_names)
       _subdomain_ids.insert(_mesh->getSubdomainID(name));
   }
  
   if (_current_task == "validate_coordinate_systems")
   {
     // use either block restriction list or list of all subdomains in the mesh
     const auto & check_subdomains =
         _subdomain_ids.empty() ? _problem->mesh().meshSubdomains() : _subdomain_ids;
     if (check_subdomains.empty())
       mooseError("No subdomains found");
  
     // make sure all subdomains are using the same coordinate system
     _coord_system = _problem->getCoordSystem(*check_subdomains.begin());
     for (auto subdomain : check_subdomains)
       if (_problem->getCoordSystem(subdomain) != _coord_system)
         mooseError("The TensorMechanics action requires all subdomains to have the same coordinate "
                    "system.");
  
     if (_coord_system == Moose::COORD_RZ)
     {
       if (_out_of_plane_direction != OutOfPlaneDirection::z)
         mooseError("'out_of_plane_direction' must be 'z' for axisymmetric simulations");
     }
     else if (_planar_formulation != PlanarFormulation::None)
     {
       if (_out_of_plane_direction == OutOfPlaneDirection::z && _ndisp != 2)
         mooseError(
             "Must specify two displacements for plane strain when the out of plane direction is z");
       else if (_out_of_plane_direction != OutOfPlaneDirection::z && _ndisp != 3)
         mooseError("Must specify three displacements for plane strain when the out of plane "
                    "direction is x or y");
     }
   }
 }

Referenced by TensorMechanicsAction::act().

◆ getKernelParameters()

InputParameters TensorMechanicsAction::getKernelParameters ( std::string type )

protectedvirtualinherited

Definition at line 544 of file TensorMechanicsAction.C.

 {
   InputParameters params = _factory.getValidParams(type);
   params.applyParameters(parameters(),
                          {"displacements",
                           "use_displaced_mesh",
                           "save_in",
                           "diag_save_in",
                           "out_of_plane_strain"});
  
   params.set<std::vector<VariableName>>("displacements") = _coupled_displacements;
   params.set<bool>("use_displaced_mesh") = _use_displaced_mesh;
  
   return params;
 }

Referenced by TensorMechanicsAction::act().

◆ getKernelType()

std::string TensorMechanicsAction::getKernelType ( )

protectedvirtualinherited

Reimplemented in DynamicTensorMechanicsAction.

Definition at line 528 of file TensorMechanicsAction.C.

 {
   std::map<Moose::CoordinateSystemType, std::string> type_map = {
       {Moose::COORD_XYZ, "StressDivergenceTensors"},
       {Moose::COORD_RZ, "StressDivergenceRZTensors"},
       {Moose::COORD_RSPHERICAL, "StressDivergenceRSphericalTensors"}};
  
   // choose kernel type based on coordinate system
   auto type_it = type_map.find(_coord_system);
   if (type_it != type_map.end())
     return type_it->second;
   else
     mooseError("Unsupported coordinate system");
 }

Referenced by TensorMechanicsAction::act().

◆ outputPropertiesType()

MultiMooseEnum TensorMechanicsActionBase::outputPropertiesType ( )

staticinherited

Definition at line 134 of file TensorMechanicsActionBase.C.

 {
   std::string options = "";
   for (auto & r2a : _ranktwoaux_table)
     for (unsigned int a = 0; a < 3; ++a)
       for (unsigned int b = 0; b < 3; ++b)
         options += (options == "" ? "" : " ") + r2a.first + '_' + _component_table[a] +
                    _component_table[b];
  
   for (auto & r2sa : _ranktwoscalaraux_table)
     for (auto & t : r2sa.second.second)
       options += " " + r2sa.first + "_" + t;
  
   return MultiMooseEnum(options);
 }

Referenced by TensorMechanicsAction::validParams(), and TensorMechanicsActionBase::validParams().

◆ validParams()

InputParameters PoroMechanicsAction::validParams ( )

static

Definition at line 26 of file PoroMechanicsAction.C.

 {
   InputParameters params = TensorMechanicsAction::validParams();
   params.addRequiredParam<VariableName>("porepressure", "The pore pressure variable");
   return params;
 }

Member Data Documentation

◆ _base_name

const std::string TensorMechanicsAction::_base_name

protectedinherited

base name for the current master action block

Definition at line 93 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::actOutputGeneration().

◆ _component_table

const std::vector< char > TensorMechanicsActionBase::_component_table = {'x', 'y', 'z'}

staticinherited

Definition at line 31 of file TensorMechanicsActionBase.h.

Referenced by TensorMechanicsAction::actOutputGeneration(), and TensorMechanicsActionBase::outputPropertiesType().

◆ _coord_system

Moose::CoordinateSystemType TensorMechanicsAction::_coord_system

protectedinherited

Definition at line 47 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::act(), TensorMechanicsAction::actSubdomainChecks(), DynamicTensorMechanicsAction::getKernelType(), and TensorMechanicsAction::getKernelType().

◆ _coupled_displacements

std::vector<VariableName> TensorMechanicsAction::_coupled_displacements

protectedinherited

Definition at line 39 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::act(), TensorMechanicsAction::getKernelParameters(), and TensorMechanicsAction::TensorMechanicsAction().

◆ _diag_save_in

std::vector<AuxVariableName> TensorMechanicsAction::_diag_save_in

protectedinherited

Definition at line 44 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::act(), and TensorMechanicsAction::TensorMechanicsAction().

◆ _displacements

std::vector<VariableName> TensorMechanicsAction::_displacements

protectedinherited

displacement variables

Definition at line 37 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::act(), and TensorMechanicsAction::TensorMechanicsAction().

◆ _generate_output

std::vector<std::string> TensorMechanicsAction::_generate_output

protectedinherited

output aux variables to generate for sclar stress/strain tensor quantities

Definition at line 99 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::actOutputGeneration(), and TensorMechanicsAction::TensorMechanicsAction().

◆ _ndisp

unsigned int TensorMechanicsAction::_ndisp

protectedinherited

Definition at line 38 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::act(), TensorMechanicsAction::actSubdomainChecks(), and TensorMechanicsAction::TensorMechanicsAction().

◆ _out_of_plane_direction

const OutOfPlaneDirection TensorMechanicsAction::_out_of_plane_direction

protectedinherited

Definition at line 90 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::act(), and TensorMechanicsAction::actSubdomainChecks().

◆ _planar_formulation

enum TensorMechanicsAction::PlanarFormulation TensorMechanicsAction::_planar_formulation

protectedinherited

Referenced by TensorMechanicsAction::act(), TensorMechanicsAction::actSubdomainChecks(), and TensorMechanicsAction::TensorMechanicsAction().

◆ _ranktwoaux_table

const std::map< std::string, std::string > TensorMechanicsActionBase::_ranktwoaux_table

staticinherited

Initial value:

= {
    {"strain", "total_strain"},
    {"stress", "stress"},
    {"elastic_strain", "elastic_strain"},
    {"plastic_strain", "plastic_strain"},
    {"creep_strain", "creep_strain"}}

table data for output generation

Definition at line 30 of file TensorMechanicsActionBase.h.

Referenced by TensorMechanicsAction::actOutputGeneration(), and TensorMechanicsActionBase::outputPropertiesType().

◆ _ranktwoscalaraux_table

const std::map< std::string, std::pair< std::string, std::vector< std::string > > > TensorMechanicsActionBase::_ranktwoscalaraux_table

staticinherited

Initial value:

= {
        {"vonmises", {"VonMisesStress", {"stress"}}},
        {"hydrostatic", {"Hydrostatic", {"stress"}}},
        {"max_principal", {"MaxPrincipal", {"stress"}}},
        {"mid_principal", {"MidPrincipal", {"stress"}}},
        {"min_principal", {"MinPrincipal", {"stress"}}},
        {"firstinv", {"FirstInvariant", {"stress", "strain"}}},
        {"secondinv", {"SecondInvariant", {"stress", "strain"}}},
        {"thirdinv", {"ThirdInvariant", {"stress", "strain"}}}}

Definition at line 33 of file TensorMechanicsActionBase.h.

Referenced by TensorMechanicsAction::actOutputGeneration(), and TensorMechanicsActionBase::outputPropertiesType().

◆ _save_in

std::vector<AuxVariableName> TensorMechanicsAction::_save_in

protectedinherited

residual debugging

Definition at line 43 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::act(), and TensorMechanicsAction::TensorMechanicsAction().

◆ _strain

enum TensorMechanicsAction::Strain TensorMechanicsAction::_strain

protectedinherited

Referenced by TensorMechanicsAction::TensorMechanicsAction().

◆ _strain_and_increment

enum TensorMechanicsAction::StrainAndIncrement TensorMechanicsAction::_strain_and_increment

protectedinherited

Referenced by TensorMechanicsAction::act(), and TensorMechanicsAction::TensorMechanicsAction().

◆ _subdomain_id_union

std::set<SubdomainID> TensorMechanicsAction::_subdomain_id_union

protectedinherited

set generated from the combined block restrictions of all TensorMechanics/Master action blocks

Definition at line 56 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::actGatherActionParameters().

◆ _subdomain_ids

std::set<SubdomainID> TensorMechanicsAction::_subdomain_ids

protectedinherited

set generated from the passed in vector of subdomain names

Definition at line 53 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::actSubdomainChecks().

◆ _subdomain_names

std::vector<SubdomainName> TensorMechanicsAction::_subdomain_names

protectedinherited

if this vector is not empty the variables, kernels and materials are restricted to these subdomains

Definition at line 50 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::actSubdomainChecks().

◆ _use_ad

const bool TensorMechanicsActionBase::_use_ad

protectedinherited

Definition at line 37 of file TensorMechanicsActionBase.h.

Referenced by TensorMechanicsAction::act(), and PoroMechanicsAction().

◆ _use_displaced_mesh

bool TensorMechanicsAction::_use_displaced_mesh

protectedinherited

use displaced mesh (true unless _strain is SMALL)

Definition at line 96 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::act(), TensorMechanicsAction::getKernelParameters(), and TensorMechanicsAction::TensorMechanicsAction().

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

tensor_mechanics/include/actions/PoroMechanicsAction.h
tensor_mechanics/src/actions/PoroMechanicsAction.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ OutOfPlaneDirection

◆ PlanarFormulation

◆ Strain

◆ StrainAndIncrement

Constructor & Destructor Documentation

◆ PoroMechanicsAction()

Member Function Documentation

◆ act()

◆ actGatherActionParameters()

◆ actOutputGeneration()

◆ actSubdomainChecks()

◆ getKernelParameters()

◆ getKernelType()

◆ outputPropertiesType()

◆ validParams()

Member Data Documentation

◆ _base_name

◆ _component_table

◆ _coord_system

◆ _coupled_displacements

◆ _diag_save_in

◆ _displacements

◆ _generate_output

◆ _ndisp

◆ _out_of_plane_direction

◆ _planar_formulation

◆ _ranktwoaux_table

◆ _ranktwoscalaraux_table

◆ _save_in

◆ _strain

◆ _strain_and_increment

◆ _subdomain_id_union

◆ _subdomain_ids

◆ _subdomain_names

◆ _use_ad

◆ _use_displaced_mesh