https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
QuasiStaticSolidMechanicsPhysicsBase Class Referenceabstract

#include <QuasiStaticSolidMechanicsPhysicsBase.h>

Inheritance diagram for QuasiStaticSolidMechanicsPhysicsBase:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 QuasiStaticSolidMechanicsPhysicsBase (const InputParameters &params)
 
void timedAct ()
 
virtual void addRelationshipManagers (Moose::RelationshipManagerType when_type)
 
MooseObjectName uniqueActionName () const
 
const std::string & specificTaskName () const
 
const std::set< std::string > & getAllTasks () const
 
void appendTask (const std::string &task)
 
MooseAppgetMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParametersparameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
PerfGraphperfGraph ()
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static MultiMooseEnum outputPropertiesType ()
 
static MultiMooseEnum materialOutputOrders ()
 
static MultiMooseEnum materialOutputFamilies ()
 
static void addCartesianComponentOutput (const std::string &name, const std::string &prop_name="")
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr auto SYSTEM
 
static constexpr auto NAME
 
static const std::vector< char > _component_table = {'x', 'y', 'z'}
 table data for output generation More...
 
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _rank_two_invariant_table
 
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _rank_two_directional_component_table
 
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _rank_two_cylindrical_component_table
 
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _rank_two_spherical_component_table
 

Protected Member Functions

bool addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
 
virtual void act ()=0
 
void associateWithParameter (const std::string &param_name, InputParameters &params) const
 
void associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

const bool _use_ad
 
std::string _registered_identifier
 
std::string _specific_task_name
 
std::set< std::string > _all_tasks
 
ActionWarehouse_awh
 
const std::string & _current_task
 
std::shared_ptr< MooseMesh > & _mesh
 
std::shared_ptr< MooseMesh > & _displaced_mesh
 
std::shared_ptr< FEProblemBase > & _problem
 
PerfID _act_timer
 
MooseApp_app
 
const std::string _type
 
const std::string _name
 
const InputParameters_pars
 
Factory_factory
 
ActionFactory_action_factory
 
MooseApp_pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

static std::map< std::string, std::string > _rank_two_cartesian_component_table
 

Detailed Description

Definition at line 14 of file QuasiStaticSolidMechanicsPhysicsBase.h.

Constructor & Destructor Documentation

◆ QuasiStaticSolidMechanicsPhysicsBase()

QuasiStaticSolidMechanicsPhysicsBase::QuasiStaticSolidMechanicsPhysicsBase ( const InputParameters params)

Definition at line 250 of file QuasiStaticSolidMechanicsPhysicsBase.C.

252  : Action(parameters), _use_ad(getParam<bool>("use_automatic_differentiation"))
253 {
254  const auto & params = _app.getInputParameterWarehouse().getInputParameters();
255  InputParameters & pars(*(params.find(uniqueActionName())->second.get()));
256 
257  // check if a container block with common parameters is found
258  auto action = _awh.getActions<CommonSolidMechanicsAction>();
259  if (action.size() == 1)
260  pars.applyParameters(action[0]->parameters());
261 
262  // append additional_generate_output
263  if (isParamValid("additional_generate_output"))
264  {
265  MultiMooseEnum generate_output = getParam<MultiMooseEnum>("generate_output");
266  MultiMooseEnum additional_generate_output =
267  getParam<MultiMooseEnum>("additional_generate_output");
268 
269  MultiMooseEnum material_output_order = getParam<MultiMooseEnum>("material_output_order");
270  MultiMooseEnum additional_material_output_order =
271  getParam<MultiMooseEnum>("additional_material_output_order");
272 
273  MultiMooseEnum material_output_family = getParam<MultiMooseEnum>("material_output_family");
274  MultiMooseEnum additional_material_output_family =
275  getParam<MultiMooseEnum>("additional_material_output_family");
276 
277  for (auto & output : additional_generate_output)
278  generate_output.setAdditionalValue(output);
279  for (auto & order : additional_material_output_order)
280  material_output_order.setAdditionalValue(order);
281  for (auto & family : additional_material_output_family)
282  material_output_family.setAdditionalValue(family);
283 
284  pars.set<MultiMooseEnum>("generate_output") = generate_output;
285  pars.set<MultiMooseEnum>("material_output_order") = material_output_order;
286  pars.set<MultiMooseEnum>("material_output_family") = material_output_family;
287  }
288 }
ActionWarehouse & _awh
void setAdditionalValue(const std::string &names)
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
InputParameterWarehouse & getInputParameterWarehouse()
Action(const InputParameters &parameters)
MooseApp & _app
Store common tensor mechanics parameters.
MooseObjectName uniqueActionName() const
bool isParamValid(const std::string &name) const
const std::multimap< MooseObjectName, std::shared_ptr< InputParameters > > & getInputParameters(THREAD_ID tid=0) const
const InputParameters & parameters() const
std::vector< const T *> getActions()

Member Function Documentation

◆ addCartesianComponentOutput()

void QuasiStaticSolidMechanicsPhysicsBase::addCartesianComponentOutput ( const std::string &  name,
const std::string &  prop_name = "" 
)
static

Definition at line 334 of file QuasiStaticSolidMechanicsPhysicsBase.C.

336 {
337  if (prop_name.empty())
338  // the enum name is the actual tensor material property name
339  _rank_two_cartesian_component_table.emplace(enum_name, enum_name);
340  else
341  // supply a different name for the enum options (this is done for
342  // 'strain' -> 'mechanical_strain' in the TMA)
343  _rank_two_cartesian_component_table.emplace(enum_name, prop_name);
344 }
static std::map< std::string, std::string > _rank_two_cartesian_component_table

◆ materialOutputFamilies()

MultiMooseEnum QuasiStaticSolidMechanicsPhysicsBase::materialOutputFamilies ( )
static

Definition at line 299 of file QuasiStaticSolidMechanicsPhysicsBase.C.

Referenced by validParams(), and QuasiStaticSolidMechanicsPhysics::validParams().

300 {
301  return MultiMooseEnum("MONOMIAL LAGRANGE");
302 }

◆ materialOutputOrders()

MultiMooseEnum QuasiStaticSolidMechanicsPhysicsBase::materialOutputOrders ( )
static

Definition at line 291 of file QuasiStaticSolidMechanicsPhysicsBase.C.

Referenced by validParams(), and QuasiStaticSolidMechanicsPhysics::validParams().

292 {
294 
295  return MultiMooseEnum(orders);
296 }
std::string getRawNames() const
static MooseEnum getAuxVariableOrders()

◆ outputPropertiesType()

MultiMooseEnum QuasiStaticSolidMechanicsPhysicsBase::outputPropertiesType ( )
static

Definition at line 305 of file QuasiStaticSolidMechanicsPhysicsBase.C.

Referenced by validParams(), and QuasiStaticSolidMechanicsPhysics::validParams().

306 {
307  std::string options = "";
308  for (auto & r2tc : _rank_two_cartesian_component_table)
309  for (unsigned int a = 0; a < 3; ++a)
310  for (unsigned int b = 0; b < 3; ++b)
311  options += (options == "" ? "" : " ") + r2tc.first + '_' + _component_table[a] +
313 
314  for (auto & r2i : _rank_two_invariant_table)
315  for (auto & t : r2i.second.second)
316  options += " " + r2i.first + "_" + t;
317 
318  for (auto & r2sdc : _rank_two_directional_component_table)
319  for (auto & r : r2sdc.second.second)
320  options += " " + r2sdc.first + "_" + r;
321 
322  for (auto & r2cc : _rank_two_cylindrical_component_table)
323  for (auto & r : r2cc.second.second)
324  options += " " + r2cc.first + "_" + r;
325 
326  for (auto & r2sc : _rank_two_spherical_component_table)
327  for (auto & r : r2sc.second.second)
328  options += " " + r2sc.first + "_" + r;
329 
330  return MultiMooseEnum(options, "", true);
331 }
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _rank_two_invariant_table
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _rank_two_cylindrical_component_table
static const std::vector< char > _component_table
table data for output generation
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _rank_two_directional_component_table
static std::map< std::string, std::string > _rank_two_cartesian_component_table
static const std::map< std::string, std::pair< std::string, std::vector< std::string > > > _rank_two_spherical_component_table

◆ validParams()

InputParameters QuasiStaticSolidMechanicsPhysicsBase::validParams ( )
static

Definition at line 137 of file QuasiStaticSolidMechanicsPhysicsBase.C.

Referenced by QuasiStaticSolidMechanicsPhysics::validParams(), and CommonSolidMechanicsAction::validParams().

138 {
140 
141  params.addRequiredParam<std::vector<VariableName>>(
142  "displacements", "The nonlinear displacement variables for the problem");
143  params.addParam<std::vector<VariableName>>("temperature", "The temperature");
144 
145  MooseEnum strainType("SMALL FINITE", "SMALL");
146  params.addParam<MooseEnum>("strain", strainType, "Strain formulation");
147  params.addParam<bool>("incremental",
148  "Use incremental or total strain (if not explicitly specified this "
149  "defaults to incremental for finite strain and total for small strain)");
150 
151  params.addParam<std::string>("base_name", "Material property base name");
152  params.addParam<bool>(
153  "volumetric_locking_correction", false, "Flag to correct volumetric locking");
154  params.addParam<bool>(
155  "use_finite_deform_jacobian", false, "Jacobian for corrotational finite strain");
156  params.addParam<bool>("add_variables", false, "Add the displacement variables");
157  params.addParam<std::vector<MaterialPropertyName>>(
158  "eigenstrain_names", {}, "List of eigenstrains to be applied in this strain calculation");
159  params.addParam<bool>("use_automatic_differentiation",
160  false,
161  "Flag to use automatic differentiation (AD) objects when possible");
162  // Global Strain
163  params.addParam<MaterialPropertyName>(
164  "global_strain",
165  "Name of the global strain material to be applied in this strain calculation. "
166  "The global strain tensor is constant over the whole domain and allows visualization "
167  "of the deformed shape with the periodic BC");
168 
169  // Advanced
170  params.addParam<std::vector<AuxVariableName>>("save_in", {}, "The displacement residuals");
171  params.addParam<std::vector<AuxVariableName>>(
172  "diag_save_in", {}, "The displacement diagonal preconditioner terms");
173  params.addParam<MooseEnum>("decomposition_method",
175  "Methods to calculate the finite strain and rotation increments");
176  params.addParamNamesToGroup("save_in diag_save_in", "Advanced");
177 
178  // Planar Formulation
179  MooseEnum planarFormulationType("NONE WEAK_PLANE_STRESS PLANE_STRAIN GENERALIZED_PLANE_STRAIN",
180  "NONE");
181  params.addParam<MooseEnum>(
182  "planar_formulation", planarFormulationType, "Out-of-plane stress/strain formulation");
183  params.addParam<VariableName>("scalar_out_of_plane_strain",
184  "Scalar variable for the out-of-plane strain (in y "
185  "direction for 1D Axisymmetric or in z direction for 2D "
186  "Cartesian problems)");
187  params.addParam<VariableName>("out_of_plane_strain",
188  "Variable for the out-of-plane strain for plane stress models");
189  MooseEnum outOfPlaneDirection("x y z", "z");
190  params.addParam<MooseEnum>(
191  "out_of_plane_direction", outOfPlaneDirection, "The direction of the out-of-plane strain.");
192  params.addDeprecatedParam<FunctionName>(
193  "out_of_plane_pressure",
194  "Function used to prescribe pressure (applied toward the body) in the out-of-plane direction "
195  "(y for 1D Axisymmetric or z for 2D Cartesian problems)",
196  "This has been replaced by 'out_of_plane_pressure_function'");
197  params.addParam<FunctionName>(
198  "out_of_plane_pressure_function",
199  "Function used to prescribe pressure (applied toward the body) in the out-of-plane direction "
200  "(y for 1D Axisymmetric or z for 2D Cartesian problems)");
201  params.addParam<Real>(
202  "pressure_factor",
203  "Scale factor applied to prescribed out-of-plane pressure (both material and function)");
204  params.addParam<MaterialPropertyName>("out_of_plane_pressure_material",
205  "0",
206  "Material used to prescribe pressure (applied toward the "
207  "body) in the out-of-plane direction");
208  params.addParamNamesToGroup("planar_formulation scalar_out_of_plane_strain out_of_plane_pressure "
209  "out_of_plane_pressure_material out_of_plane_pressure_function "
210  "pressure_factor out_of_plane_direction out_of_plane_strain",
211  "Out-of-plane stress/strain");
212 
213  // Output
214  params.addParam<MultiMooseEnum>("generate_output",
216  "Add scalar quantity output for stress and/or strain");
217 
218  params.addParam<MultiMooseEnum>(
219  "material_output_order",
221  "Specifies the order of the FE shape function to use for this variable.");
222 
223  params.addParam<MultiMooseEnum>(
224  "material_output_family",
226  "Specifies the family of FE shape functions to use for this variable.");
227  params.addParamNamesToGroup("generate_output material_output_order material_output_family",
228  "Output");
229  params.addParam<bool>("verbose", false, "Display extra information.");
230 
231  params.addParam<bool>("new_system",
232  false,
233  "If true use the new "
234  "LagrangianStressDiverence kernels.");
235 
236  MooseEnum formulationType("TOTAL UPDATED", "TOTAL");
237  params.addParam<MooseEnum>("formulation",
238  formulationType,
239  "Select between the total Lagrangian (TOTAL) "
240  "and updated Lagrangian (UPDATED) formulations "
241  "for the new kernel system.");
242 
243  params.addParamNamesToGroup("add_variables displacements temperature", "Variables");
244  params.addParamNamesToGroup("strain incremental use_finite_deform_jacobian eigenstrain_names",
245  "Strain");
246 
247  return params;
248 }
void addDeprecatedParam(const std::string &name, const T &value, const std::string &doc_string, const std::string &deprecation_message)
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addRequiredParam(const std::string &name, const std::string &doc_string)
static InputParameters validParams()
static MooseEnum decompositionType()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)

Member Data Documentation

◆ _component_table

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

table data for output generation

Definition at line 27 of file QuasiStaticSolidMechanicsPhysicsBase.h.

Referenced by QuasiStaticSolidMechanicsPhysics::actOutputMatProp(), and outputPropertiesType().

◆ _rank_two_cartesian_component_table

std::map< std::string, std::string > QuasiStaticSolidMechanicsPhysicsBase::_rank_two_cartesian_component_table
staticprotected
Initial value:
= {
{"strain", "total_strain"},
{"mechanical_strain", "mechanical_strain"},
{"stress", "stress"},
{"cauchy_stress", "cauchy_stress"},
{"deformation_gradient", "deformation_gradient"},
{"pk1_stress", "pk1_stress"},
{"pk2_stress", "pk2_stress"},
{"small_stress", "small_stress"},
{"elastic_strain", "elastic_strain"},
{"plastic_strain", "plastic_strain"},
{"creep_strain", "creep_strain"},
{"creep_stress", "creep_stress"}}

Definition at line 42 of file QuasiStaticSolidMechanicsPhysicsBase.h.

Referenced by QuasiStaticSolidMechanicsPhysics::actOutputMatProp(), addCartesianComponentOutput(), outputPropertiesType(), and QuasiStaticSolidMechanicsPhysics::setupOutput().

◆ _rank_two_cylindrical_component_table

const std::map< std::string, std::pair< std::string, std::vector< std::string > > > QuasiStaticSolidMechanicsPhysicsBase::_rank_two_cylindrical_component_table
static
Initial value:
= {
{"axial",
{"AxialStress", {"stress", "strain", "plastic_strain", "creep_strain", "elastic_strain"}}},
{"hoop",
{"HoopStress", {"stress", "strain", "plastic_strain", "creep_strain", "elastic_strain"}}},
{"radial", {"RadialStress", {"stress", "strain"}}}}

Definition at line 33 of file QuasiStaticSolidMechanicsPhysicsBase.h.

Referenced by QuasiStaticSolidMechanicsPhysics::actOutputMatProp(), and outputPropertiesType().

◆ _rank_two_directional_component_table

const std::map< std::string, std::pair< std::string, std::vector< std::string > > > QuasiStaticSolidMechanicsPhysicsBase::_rank_two_directional_component_table
static
Initial value:
= {
{"directional", {"Direction", {"stress", "strain"}}}}

Definition at line 31 of file QuasiStaticSolidMechanicsPhysicsBase.h.

Referenced by QuasiStaticSolidMechanicsPhysics::actOutputMatProp(), and outputPropertiesType().

◆ _rank_two_invariant_table

const std::map< std::string, std::pair< std::string, std::vector< std::string > > > QuasiStaticSolidMechanicsPhysicsBase::_rank_two_invariant_table
static

◆ _rank_two_spherical_component_table

const std::map< std::string, std::pair< std::string, std::vector< std::string > > > QuasiStaticSolidMechanicsPhysicsBase::_rank_two_spherical_component_table
static
Initial value:
= {
{"spherical_hoop",
{"HoopStress", {"stress", "strain", "plastic_strain", "creep_strain", "elastic_strain"}}},
{"spherical_radial", {"RadialStress", {"stress", "strain"}}}}

Definition at line 35 of file QuasiStaticSolidMechanicsPhysicsBase.h.

Referenced by QuasiStaticSolidMechanicsPhysics::actOutputMatProp(), and outputPropertiesType().

◆ _use_ad

const bool QuasiStaticSolidMechanicsPhysicsBase::_use_ad
protected

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