www.mooseframework.org
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
PoroMechanicsAction Class Reference

#include <PoroMechanicsAction.h>

Inheritance diagram for PoroMechanicsAction:
[legend]

Public Member Functions

 PoroMechanicsAction (const InputParameters &params)
 
virtual void act ()
 

Static Public Member Functions

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::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
 
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 20 of file PoroMechanicsAction.h.

Member Enumeration Documentation

◆ OutOfPlaneDirection

enum TensorMechanicsAction::OutOfPlaneDirection
strongprotectedinherited
Enumerator

Definition at line 82 of file TensorMechanicsAction.h.

83  {
84  x,
85  y,
86  z
87  };

◆ PlanarFormulation

enum TensorMechanicsAction::PlanarFormulation
strongprotectedinherited

use an out of plane stress/strain formulation

Enumerator
None 
PlaneStrain 
GeneralizedPlaneStrain 

Definition at line 74 of file TensorMechanicsAction.h.

75  {
76  None,
77  PlaneStrain,
79  /* PlaneStress */
enum TensorMechanicsAction::PlanarFormulation _planar_formulation

◆ Strain

enum TensorMechanicsAction::Strain
strongprotectedinherited

strain formulation

Enumerator
Small 
Finite 

Definition at line 58 of file TensorMechanicsAction.h.

59  {
60  Small,
61  Finite
62  } _strain;
enum TensorMechanicsAction::Strain _strain

◆ StrainAndIncrement

enum TensorMechanicsAction::StrainAndIncrement
strongprotectedinherited

strain formulation

Enumerator
SmallTotal 
FiniteTotal 
SmallIncremental 
FiniteIncremental 

Definition at line 65 of file TensorMechanicsAction.h.

66  {
67  SmallTotal,
68  FiniteTotal,
69  SmallIncremental,
70  FiniteIncremental
enum TensorMechanicsAction::StrainAndIncrement _strain_and_increment

Constructor & Destructor Documentation

◆ PoroMechanicsAction()

PoroMechanicsAction::PoroMechanicsAction ( const InputParameters &  params)

Definition at line 32 of file PoroMechanicsAction.C.

33  : TensorMechanicsAction(params)
34 {
35  if (_use_ad)
36  paramError("use_ad", "AD not setup for use with PoroMechanicsAction");
37 }
TensorMechanicsAction(const InputParameters &params)

Member Function Documentation

◆ act()

void PoroMechanicsAction::act ( )
virtual

Reimplemented from TensorMechanicsAction.

Definition at line 40 of file PoroMechanicsAction.C.

41 {
43 
44  if (_current_task == "add_kernel")
45  {
46  // Prepare displacements and set value for dim
47  std::vector<VariableName> displacements = getParam<std::vector<VariableName>>("displacements");
48  unsigned int dim = displacements.size();
49 
50  // all the kernels added below have porepressure as a coupled variable
51  // add this to the kernel's params
52  std::string type("PoroMechanicsCoupling");
53  InputParameters params = _factory.getValidParams(type);
54  VariableName pp_var(getParam<VariableName>("porepressure"));
55  params.addCoupledVar("porepressure", "");
56  params.set<std::vector<VariableName>>("porepressure") = {pp_var};
57 
58  // now add the kernels
59  for (unsigned int i = 0; i < dim; ++i)
60  {
61  std::string kernel_name = "PoroMechanics" + Moose::stringify(i);
62 
63  params.set<unsigned int>("component") = i;
64  params.set<NonlinearVariableName>("variable") = displacements[i];
65 
66  _problem->addKernel(type, kernel_name, params);
67  }
68  }
69 }

◆ actGatherActionParameters()

void TensorMechanicsAction::actGatherActionParameters ( )
protectedinherited

Definition at line 453 of file TensorMechanicsAction.C.

Referenced by TensorMechanicsAction::act().

454 {
455  //
456  // Gather info about all other master actions when we add variables
457  //
458  if (_current_task == "validate_coordinate_systems" && getParam<bool>("add_variables"))
459  {
460  auto actions = _awh.getActions<TensorMechanicsAction>();
461  for (const auto & action : actions)
462  {
463  const auto size_before = _subdomain_id_union.size();
464  const auto added_size = action->_subdomain_ids.size();
465  _subdomain_id_union.insert(action->_subdomain_ids.begin(), action->_subdomain_ids.end());
466  const auto size_after = _subdomain_id_union.size();
467 
468  if (size_after != size_before + added_size)
469  mooseError("The block restrictions in the TensorMechanics/Master actions must be "
470  "non-overlapping.");
471 
472  if (added_size == 0 && actions.size() > 1)
473  mooseError("No TensorMechanics/Master action can be block unrestricted if more than one "
474  "TensorMechanics/Master action is specified.");
475  }
476  }
477 }
std::set< SubdomainID > _subdomain_id_union
set generated from the combined block restrictions of all TensorMechanics/Master action blocks ...

◆ actOutputGeneration()

void TensorMechanicsAction::actOutputGeneration ( )
protectedinherited

Definition at line 379 of file TensorMechanicsAction.C.

Referenced by TensorMechanicsAction::act().

380 {
381  //
382  // Add variables (optional)
383  //
384  if (_current_task == "add_aux_variable")
385  {
386  // Loop through output aux variables
387  for (auto out : _generate_output)
388  {
389  // Create output helper aux variables
390  _problem->addAuxVariable(out,
391  FEType(Utility::string_to_enum<Order>("CONSTANT"),
392  Utility::string_to_enum<FEFamily>("MONOMIAL")),
393  _subdomain_id_union.empty() ? nullptr : &_subdomain_id_union);
394  }
395  }
396 
397  //
398  // Add output AuxKernels
399  //
400  else if (_current_task == "add_aux_kernel")
401  {
402  // Loop through output aux variables
403  for (auto out : _generate_output)
404  {
405  std::string type = "";
406  InputParameters params = emptyInputParameters();
407 
408  // RankTwoAux
409  for (const auto & r2a : _ranktwoaux_table)
410  for (unsigned int a = 0; a < 3; ++a)
411  for (unsigned int b = 0; b < 3; ++b)
412  if (r2a.first + '_' + _component_table[a] + _component_table[b] == out)
413  {
414  type = "RankTwoAux";
415  params = _factory.getValidParams(type);
416  params.set<MaterialPropertyName>("rank_two_tensor") = r2a.second;
417  params.set<unsigned int>("index_i") = a;
418  params.set<unsigned int>("index_j") = b;
419  }
420 
421  // RankTwoScalarAux
422  for (const auto & r2sa : _ranktwoscalaraux_table)
423  for (const auto & t : r2sa.second.second)
424  if (r2sa.first + '_' + t == out)
425  {
426  const auto r2a = _ranktwoaux_table.find(t);
427  if (r2a != _ranktwoaux_table.end())
428  {
429  type = "RankTwoScalarAux";
430  params = _factory.getValidParams(type);
431  params.set<MaterialPropertyName>("rank_two_tensor") = r2a->second;
432  params.set<MooseEnum>("scalar_type") = r2sa.second.first;
433  }
434  else
435  mooseError("Internal error. The permitted tensor shortcuts in "
436  "'_ranktwoscalaraux_table' must be keys in the '_ranktwoaux_table'.");
437  }
438 
439  if (type != "")
440  {
441  params.applyParameters(parameters());
442  params.set<AuxVariableName>("variable") = out;
443  params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
444  _problem->addAuxKernel(type, out + '_' + name(), params);
445  }
446  else
447  mooseError("Unable to add output AuxKernel");
448  }
449  }
450 }
static const std::vector< char > _component_table
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _ranktwoscalaraux_table
std::set< SubdomainID > _subdomain_id_union
set generated from the combined block restrictions of all TensorMechanics/Master action blocks ...
const std::string name
Definition: Setup.h:22
std::vector< std::string > _generate_output
output aux variables to generate for sclar stress/strain tensor quantities
static const std::map< std::string, std::string > _ranktwoaux_table
table data for output generation

◆ actSubdomainChecks()

void TensorMechanicsAction::actSubdomainChecks ( )
protectedinherited

Definition at line 346 of file TensorMechanicsAction.C.

Referenced by TensorMechanicsAction::act().

347 {
348  //
349  // Do the coordinate system check only once the problem is created
350  //
351  if (_current_task == "setup_mesh_complete")
352  {
353  // get subdomain IDs
354  for (auto & name : _subdomain_names)
355  _subdomain_ids.insert(_mesh->getSubdomainID(name));
356  }
357 
358  if (_current_task == "validate_coordinate_systems")
359  {
360  // use either block restriction list or list of all subdomains in the mesh
361  const auto & check_subdomains =
362  _subdomain_ids.empty() ? _problem->mesh().meshSubdomains() : _subdomain_ids;
363  if (check_subdomains.empty())
364  mooseError("No subdomains found");
365 
366  // make sure all subdomains are using the same coordinate system
367  _coord_system = _problem->getCoordSystem(*check_subdomains.begin());
368  for (auto subdomain : check_subdomains)
369  if (_problem->getCoordSystem(subdomain) != _coord_system)
370  mooseError("The TensorMechanics action requires all subdomains to have the same coordinate "
371  "system.");
372 
373  if (_coord_system == Moose::COORD_RZ && _out_of_plane_direction != OutOfPlaneDirection::z)
374  paramError("out_of_plane_direction", "must be set to z for axisymmetric simulations.");
375  }
376 }
std::set< SubdomainID > _subdomain_ids
set generated from the passed in vector of subdomain names
const OutOfPlaneDirection _out_of_plane_direction
const std::string name
Definition: Setup.h:22
std::vector< SubdomainName > _subdomain_names
if this vector is not empty the variables, kernels and materials are restricted to these subdomains ...
Moose::CoordinateSystemType _coord_system

◆ getKernelParameters()

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

Definition at line 496 of file TensorMechanicsAction.C.

Referenced by TensorMechanicsAction::act().

497 {
498  InputParameters params = _factory.getValidParams(type);
499  params.applyParameters(parameters(),
500  {"displacements", "use_displaced_mesh", "save_in", "diag_save_in"});
501 
502  params.set<std::vector<VariableName>>("displacements") = _coupled_displacements;
503  params.set<bool>("use_displaced_mesh") = _use_displaced_mesh;
504 
505  return params;
506 }
std::vector< VariableName > _coupled_displacements
bool _use_displaced_mesh
use displaced mesh (true unless _strain is SMALL)

◆ getKernelType()

std::string TensorMechanicsAction::getKernelType ( )
protectedvirtualinherited

Reimplemented in DynamicTensorMechanicsAction.

Definition at line 480 of file TensorMechanicsAction.C.

Referenced by TensorMechanicsAction::act().

481 {
482  std::map<Moose::CoordinateSystemType, std::string> type_map = {
483  {Moose::COORD_XYZ, "StressDivergenceTensors"},
484  {Moose::COORD_RZ, "StressDivergenceRZTensors"},
485  {Moose::COORD_RSPHERICAL, "StressDivergenceRSphericalTensors"}};
486 
487  // choose kernel type based on coordinate system
488  auto type_it = type_map.find(_coord_system);
489  if (type_it != type_map.end())
490  return type_it->second;
491  else
492  mooseError("Unsupported coordinate system");
493 }
Moose::CoordinateSystemType _coord_system

◆ outputPropertiesType()

MultiMooseEnum TensorMechanicsActionBase::outputPropertiesType ( )
staticinherited

Definition at line 131 of file TensorMechanicsActionBase.C.

Referenced by validParams< TensorMechanicsAction >(), and validParams< TensorMechanicsActionBase >().

132 {
133  std::string options = "";
134  for (auto & r2a : _ranktwoaux_table)
135  for (unsigned int a = 0; a < 3; ++a)
136  for (unsigned int b = 0; b < 3; ++b)
137  options += (options == "" ? "" : " ") + r2a.first + '_' + _component_table[a] +
138  _component_table[b];
139 
140  for (auto & r2sa : _ranktwoscalaraux_table)
141  for (auto & t : r2sa.second.second)
142  options += " " + r2sa.first + "_" + t;
143 
144  return MultiMooseEnum(options);
145 }
static const std::vector< char > _component_table
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _ranktwoscalaraux_table
static const std::map< std::string, std::string > _ranktwoaux_table
table data for output generation

Member Data Documentation

◆ _component_table

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

◆ _coord_system

Moose::CoordinateSystemType TensorMechanicsAction::_coord_system
protectedinherited

◆ _coupled_displacements

std::vector<VariableName> TensorMechanicsAction::_coupled_displacements
protectedinherited

◆ _diag_save_in

std::vector<AuxVariableName> TensorMechanicsAction::_diag_save_in
protectedinherited

◆ _displacements

std::vector<VariableName> TensorMechanicsAction::_displacements
protectedinherited

displacement variables

Definition at line 36 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 95 of file TensorMechanicsAction.h.

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

◆ _ndisp

unsigned int TensorMechanicsAction::_ndisp
protectedinherited

◆ _out_of_plane_direction

const OutOfPlaneDirection TensorMechanicsAction::_out_of_plane_direction
protectedinherited

◆ _planar_formulation

enum TensorMechanicsAction::PlanarFormulation TensorMechanicsAction::_planar_formulation
protectedinherited

◆ _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 29 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 32 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 42 of file TensorMechanicsAction.h.

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

◆ _strain

enum TensorMechanicsAction::Strain TensorMechanicsAction::_strain
protectedinherited

◆ _strain_and_increment

enum TensorMechanicsAction::StrainAndIncrement TensorMechanicsAction::_strain_and_increment
protectedinherited

◆ _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 55 of file TensorMechanicsAction.h.

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

◆ _subdomain_ids

std::set<SubdomainID> TensorMechanicsAction::_subdomain_ids
protectedinherited

set generated from the passed in vector of subdomain names

Definition at line 52 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 49 of file TensorMechanicsAction.h.

Referenced by TensorMechanicsAction::actSubdomainChecks().

◆ _use_ad

const bool TensorMechanicsActionBase::_use_ad
protectedinherited

◆ _use_displaced_mesh

bool TensorMechanicsAction::_use_displaced_mesh
protectedinherited

use displaced mesh (true unless _strain is SMALL)

Definition at line 92 of file TensorMechanicsAction.h.

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


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