PoroMechanicsAction

under construction:Undocumented Action Class

The PoroMechanicsAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# PoroMechanicsAction

!syntax description /Kernels/PoroMechanics/PoroMechanicsAction

## Overview

!! Replace these lines with information regarding the PoroMechanicsAction action.

## Example Input File Syntax

!! Describe and include an example of how to use the PoroMechanicsAction action.

!syntax parameters /Kernels/PoroMechanics/PoroMechanicsAction

Set up stress divergence kernels with coordinate system aware logic

Input Parameters

displacementsThe nonlinear displacement variables for the problem
C++ Type:std::vector
Options:
Description:The nonlinear displacement variables for the problem
porepressureThe pore pressure variable
C++ Type:VariableName
Options:
Description:The pore pressure variable

Required Parameters

active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector
Options:
Description:If specified only the blocks named will be visited and made active
add_variablesFalseAdd the displacement variables
Default:False
C++ Type:bool
Options:
Description:Add the displacement variables
base_nameMaterial property base name
C++ Type:std::string
Options:
Description:Material property base name
decomposition_methodTaylorExpansionMethods to calculate the finite strain and rotation increments
Default:TaylorExpansion
C++ Type:MooseEnum
Options:TaylorExpansion EigenSolution
Description:Methods to calculate the finite strain and rotation increments
eigenstrain_namesList of eigenstrains to be applied in this strain calculation
C++ Type:std::vector
Options:
Description:List of eigenstrains to be applied in this strain calculation
extra_vector_tagsThe tag names for extra vectors that residual data should be saved into
C++ Type:std::vector
Options:
Description:The tag names for extra vectors that residual data should be saved into
global_strainName of the global strain material to be applied in this strain calculation. The global strain tensor is constant over the whole domain and allows visualization of the deformed shape with the periodic BC
C++ Type:MaterialPropertyName
Options:
Description:Name of the global strain material to be applied in this strain calculation. The global strain tensor is constant over the whole domain and allows visualization of the deformed shape with the periodic BC
inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector
Options:
Description:If specified blocks matching these identifiers will be skipped.
incrementalFalseUse incremental or total strain
Default:False
C++ Type:bool
Options:
Description:Use incremental or total strain
strainSMALLStrain formulation
Default:SMALL
C++ Type:MooseEnum
Options:SMALL FINITE
Description:Strain formulation
strain_base_nameThe base name used for the strain. If not provided, it will be set equal to base_name
C++ Type:std::string
Options:
Description:The base name used for the strain. If not provided, it will be set equal to base_name
temperatureThe temperature
C++ Type:VariableName
Options:
Description:The temperature
use_automatic_differentiationFalseFlag to use automatic differentiation (AD) objects when possible
Default:False
C++ Type:bool
Options:
Description:Flag to use automatic differentiation (AD) objects when possible
use_displaced_meshFalseWhether to use displaced mesh in the kernels
Default:False
C++ Type:bool
Options:
Description:Whether to use displaced mesh in the kernels
use_finite_deform_jacobianFalseJacobian for corrotational finite strain
Default:False
C++ Type:bool
Options:
Description:Jacobian for corrotational finite strain
volumetric_locking_correctionFalseFlag to correct volumetric locking
Default:False
C++ Type:bool
Options:
Description:Flag to correct volumetric locking

Optional Parameters

additional_generate_outputAdd scalar quantity output for stress and/or strain (will be appended to the list in `generate_output`)
C++ Type:MultiMooseEnum
Options:creep_strain_xx creep_strain_xy creep_strain_xz creep_strain_yx creep_strain_yy creep_strain_yz creep_strain_zx creep_strain_zy creep_strain_zz elastic_strain_xx elastic_strain_xy elastic_strain_xz elastic_strain_yx elastic_strain_yy elastic_strain_yz elastic_strain_zx elastic_strain_zy elastic_strain_zz plastic_strain_xx plastic_strain_xy plastic_strain_xz plastic_strain_yx plastic_strain_yy plastic_strain_yz plastic_strain_zx plastic_strain_zy plastic_strain_zz strain_xx strain_xy strain_xz strain_yx strain_yy strain_yz strain_zx strain_zy strain_zz stress_xx stress_xy stress_xz stress_yx stress_yy stress_yz stress_zx stress_zy stress_zz firstinv_stress firstinv_strain hydrostatic_stress max_principal_stress mid_principal_stress min_principal_stress secondinv_stress secondinv_strain thirdinv_stress thirdinv_strain vonmises_stress
Description:Add scalar quantity output for stress and/or strain (will be appended to the list in `generate_output`)
generate_outputAdd scalar quantity output for stress and/or strain
C++ Type:MultiMooseEnum
Options:creep_strain_xx creep_strain_xy creep_strain_xz creep_strain_yx creep_strain_yy creep_strain_yz creep_strain_zx creep_strain_zy creep_strain_zz elastic_strain_xx elastic_strain_xy elastic_strain_xz elastic_strain_yx elastic_strain_yy elastic_strain_yz elastic_strain_zx elastic_strain_zy elastic_strain_zz plastic_strain_xx plastic_strain_xy plastic_strain_xz plastic_strain_yx plastic_strain_yy plastic_strain_yz plastic_strain_zx plastic_strain_zy plastic_strain_zz strain_xx strain_xy strain_xz strain_yx strain_yy strain_yz strain_zx strain_zy strain_zz stress_xx stress_xy stress_xz stress_yx stress_yy stress_yz stress_zx stress_zy stress_zz firstinv_stress firstinv_strain hydrostatic_stress max_principal_stress mid_principal_stress min_principal_stress secondinv_stress secondinv_strain thirdinv_stress thirdinv_strain vonmises_stress
Description:Add scalar quantity output for stress and/or strain

Output Parameters

blockThe list of ids of the blocks (subdomain) that the stress divergence kernels will be applied to
C++ Type:std::vector
Options:
Description:The list of ids of the blocks (subdomain) that the stress divergence kernels will be applied to
diag_save_inThe displacement diagonal preconditioner terms
C++ Type:std::vector
Options:
Description:The displacement diagonal preconditioner terms
save_inThe displacement residuals
C++ Type:std::vector
Options:
Description:The displacement residuals

Advanced Parameters

out_of_plane_directionzThe direction of the out-of-plane strain.
Default:z
C++ Type:MooseEnum
Options:x y z
Description:The direction of the out-of-plane strain.
out_of_plane_pressure0Function used to prescribe pressure in the out-of-plane direction (y for 1D Axisymmetric or z for 2D Cartesian problems)
Default:0
C++ Type:FunctionName
Options:
Description:Function used to prescribe pressure in the out-of-plane direction (y for 1D Axisymmetric or z for 2D Cartesian problems)
out_of_plane_strainVariable for the out-of-plane strain for plane stress models
C++ Type:VariableName
Options:
Description:Variable for the out-of-plane strain for plane stress models
planar_formulationNONEOut-of-plane stress/strain formulation
Default:NONE
C++ Type:MooseEnum
Options:NONE WEAK_PLANE_STRESS PLANE_STRAIN GENERALIZED_PLANE_STRAIN
Description:Out-of-plane stress/strain formulation
pressure_factor1Scale factor applied to prescribed pressure
Default:1
C++ Type:double
Options:
Description:Scale factor applied to prescribed pressure
scalar_out_of_plane_strainScalar variable for the out-of-plane strain (in y direction for 1D Axisymmetric or in z direction for 2D Cartesian problems)
C++ Type:VariableName
Options:
Description:Scalar variable for the out-of-plane strain (in y direction for 1D Axisymmetric or in z direction for 2D Cartesian problems)

Out-Of-Plane Stress/Strain Parameters

Input Parameters

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools