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

Action class to setup peridynamic models for solid mechanics problems. More...

#include <MechanicsActionPD.h>

Inheritance diagram for MechanicsActionPD:
[legend]

Public Member Functions

 MechanicsActionPD (const InputParameters &params)
 
virtual void act () override
 

Protected Member Functions

virtual std::string getKernelName ()
 Function to get the kernel name based on the value of member variables: _formulation and _stabilization. More...
 
virtual InputParameters getKernelParameters (std::string name)
 Function to get the input parameters for a given kernel name. More...
 

Protected Attributes

const MooseEnum _formulation
 Option of which peridynamic model needs to be setup: BOND, ORDINARY_STATE or NONORDINARY_STATE. More...
 
const MooseEnum _stabilization
 Option of stabilization scheme for correspondence material model (non-ordinary state based): FORCE or SELF. More...
 
const MooseEnum _strain
 Option of strain formulation: SMALL or FINITE. More...
 
std::vector< SubdomainName > _subdomain_names
 vector of subdomain names from provided blocks More...
 
std::set< SubdomainID > _subdomain_ids
 set of subdomain IDs generated from the passed in vector of subdomain names More...
 
std::set< SubdomainID > _subdomain_id_union
 set of SubdomainID generated from the combined block restrictions of all TensorMechanics/Master action blocks More...
 
std::vector< VariableName > _displacements
 Displacement variables. More...
 
const unsigned int _ndisp
 
std::vector< AuxVariableName > _save_in
 Residual debugging. More...
 
std::vector< AuxVariableName > _diag_save_in
 

Detailed Description

Action class to setup peridynamic models for solid mechanics problems.

Definition at line 22 of file MechanicsActionPD.h.

Constructor & Destructor Documentation

◆ MechanicsActionPD()

MechanicsActionPD::MechanicsActionPD ( const InputParameters &  params)

Definition at line 68 of file MechanicsActionPD.C.

69  : Action(params),
70  _displacements(getParam<std::vector<VariableName>>("displacements")),
71  _ndisp(_displacements.size()),
72  _formulation(getParam<MooseEnum>("formulation")),
73  _stabilization(getParam<MooseEnum>("stabilization")),
74  _strain(getParam<MooseEnum>("strain")),
75  _subdomain_names(getParam<std::vector<SubdomainName>>("block")),
77  _save_in(getParam<std::vector<AuxVariableName>>("save_in")),
78  _diag_save_in(getParam<std::vector<AuxVariableName>>("diag_save_in"))
79 {
80  // Consistency check
81  if (_save_in.size() != 0 && _save_in.size() != _ndisp)
82  mooseError("Number of save_in variables should equal to the number of displacement variables ",
83  _ndisp);
84 
85  if (_diag_save_in.size() != 0 && _diag_save_in.size() != _ndisp)
86  mooseError(
87  "Number of diag_save_in variables should equal to the number of displacement variables ",
88  _ndisp);
89 }

Member Function Documentation

◆ act()

void MechanicsActionPD::act ( )
overridevirtual

Definition at line 92 of file MechanicsActionPD.C.

93 {
94  if (_current_task == "setup_mesh_complete")
95  {
96  // get subdomain IDs
97  for (auto & name : _subdomain_names)
98  _subdomain_ids.insert(_mesh->getSubdomainID(name));
99  }
100  else if (_current_task == "create_problem_complete")
101  {
102  // Gather info about all other master actions for adding (aux)variables
103  auto actions = _awh.getActions<MechanicsActionPD>();
104  for (const auto & action : actions)
105  {
106  const auto size_before = _subdomain_id_union.size();
107  const auto added_size = action->_subdomain_ids.size();
108  _subdomain_id_union.insert(action->_subdomain_ids.begin(), action->_subdomain_ids.end());
109  const auto size_after = _subdomain_id_union.size();
110 
111  if (size_after != size_before + added_size)
112  mooseError("The block restrictions in the Peridynamics/Mechanics/Master actions must be "
113  "non-overlapping.");
114 
115  if (added_size == 0 && actions.size() > 1)
116  mooseError(
117  "No Peridynamics/Mechanics/Master action can be block unrestricted if more than one "
118  "Peridynamics/Mechanics/Master action is specified.");
119  }
120  }
121  else if (_current_task == "add_aux_variable")
122  {
123  // add the bond_status aux variable to all peridynamic domains
124  const std::string var_type = "MooseVariableConstMonomial";
125  InputParameters params = _factory.getValidParams(var_type);
126  params.set<MooseEnum>("order") = "CONSTANT";
127  params.set<MooseEnum>("family") = "MONOMIAL";
128 
129  if (!_subdomain_id_union.empty())
130  for (const SubdomainID & id : _subdomain_id_union)
131  params.set<std::vector<SubdomainName>>("block").push_back(Moose::stringify(id));
132 
133  _problem->addAuxVariable(var_type, "bond_status", params);
134  }
135  else if (_current_task == "add_ic")
136  {
137  const std::string ic_type = "ConstantIC";
138  const std::string ic_name = name() + "bond_status";
139 
140  InputParameters params = _factory.getValidParams(ic_type);
141  params.set<VariableName>("variable") = "bond_status";
142  params.set<Real>("value") = 1.0;
143 
144  // check whether this object is restricted to certain block?
145  if (isParamValid("block"))
146  params.set<std::vector<SubdomainName>>("block") = _subdomain_names;
147 
148  _problem->addInitialCondition(ic_type, ic_name, params);
149  }
150  else if (_current_task == "add_user_object")
151  {
152  // add ghosting UO
153  const std::string uo_type = "GhostElemPD";
154  const std::string uo_name = name() + "GhostElemPD";
155 
156  InputParameters params = _factory.getValidParams(uo_type);
157  params.set<bool>("use_displaced_mesh") = (_strain == "FINITE");
158 
159  _problem->addUserObject(uo_type, uo_name, params);
160  }
161  else if (_current_task == "add_kernel")
162  {
163  const std::string kernel_name = getKernelName();
164  InputParameters params = getKernelParameters(kernel_name);
165 
166  for (unsigned int i = 0; i < _ndisp; ++i)
167  {
168  const std::string kernel_object_name = name() + "Peridynamics_" + Moose::stringify(i);
169 
170  params.set<unsigned int>("component") = i;
171  params.set<NonlinearVariableName>("variable") = _displacements[i];
172 
173  if (_save_in.size() != 0)
174  params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
175  if (_diag_save_in.size() != 0)
176  params.set<std::vector<AuxVariableName>>("diag_save_in") = {_diag_save_in[i]};
177 
178  _problem->addKernel(kernel_name, kernel_object_name, params);
179  }
180  }
181  else
182  mooseError("Task error in MechanicsActionPD");
183 }

◆ getKernelName()

std::string MechanicsActionPD::getKernelName ( )
protectedvirtual

Function to get the kernel name based on the value of member variables: _formulation and _stabilization.

Returns
Kernel name

Definition at line 186 of file MechanicsActionPD.C.

187 {
188  std::string name;
189 
190  if (_formulation == "BOND")
191  name = "MechanicsBPD";
192  else if (_formulation == "ORDINARY_STATE")
193  name = "MechanicsOSPD";
194  else if (_formulation == "NONORDINARY_STATE")
195  {
196  if (_stabilization == "FORCE")
197  name = "ForceStabilizedSmallStrainMechanicsNOSPD";
198  else if (_stabilization == "SELF")
199  {
200  if (_strain == "FINITE")
201  name = "FiniteStrainMechanicsNOSPD";
202  else
203  name = "SmallStrainMechanicsNOSPD";
204  }
205  else
206  paramError("stabilization", "Unknown PD stabilization scheme. Choose from: FORCE SELF");
207  }
208  else
209  paramError(
210  "formulation",
211  "Unsupported peridynamic formulation. Choose from: BOND ORDINARY_STATE NONORDINARY_STATE");
212 
213  return name;
214 }

Referenced by act().

◆ getKernelParameters()

InputParameters MechanicsActionPD::getKernelParameters ( std::string  name)
protectedvirtual

Function to get the input parameters for a given kernel name.

Parameters
namethe name of the kernel
Returns
Parameters for the corresponding kernel

Definition at line 217 of file MechanicsActionPD.C.

218 {
219  InputParameters params = _factory.getValidParams(name);
220 
221  params.applyParameters(parameters(),
222  {"displacements",
223  "temperature",
224  "out_of_plane_strain",
225  "eigenstrain_names",
226  "use_displaced_mesh",
227  "save_in",
228  "diag_save_in"});
229 
230  params.set<std::vector<VariableName>>("displacements") = _displacements;
231  if (isParamValid("temperature"))
232  params.set<std::vector<VariableName>>("temperature") = {getParam<VariableName>("temperature")};
233  if (isParamValid("out_of_plane_strain"))
234  params.set<std::vector<VariableName>>("out_of_plane_strain") = {
235  getParam<VariableName>("out_of_plane_strain")};
236 
237  // peridynamics modules are formulated based on initial configuration
238  params.set<bool>("use_displaced_mesh") = false;
239 
240  if (_formulation == "NONORDINARY_STATE" && isParamValid("eigenstrain_names"))
241  {
242  params.set<std::vector<MaterialPropertyName>>("eigenstrain_names") =
243  getParam<std::vector<MaterialPropertyName>>("eigenstrain_names");
244  }
245 
246  return params;
247 }

Referenced by act().

Member Data Documentation

◆ _diag_save_in

std::vector<AuxVariableName> MechanicsActionPD::_diag_save_in
protected

Definition at line 72 of file MechanicsActionPD.h.

Referenced by act(), and MechanicsActionPD().

◆ _displacements

std::vector<VariableName> MechanicsActionPD::_displacements
protected

Displacement variables.

Definition at line 45 of file MechanicsActionPD.h.

Referenced by act(), and getKernelParameters().

◆ _formulation

const MooseEnum MechanicsActionPD::_formulation
protected

Option of which peridynamic model needs to be setup: BOND, ORDINARY_STATE or NONORDINARY_STATE.

Definition at line 51 of file MechanicsActionPD.h.

Referenced by getKernelName(), and getKernelParameters().

◆ _ndisp

const unsigned int MechanicsActionPD::_ndisp
protected

Definition at line 46 of file MechanicsActionPD.h.

Referenced by act(), and MechanicsActionPD().

◆ _save_in

std::vector<AuxVariableName> MechanicsActionPD::_save_in
protected

Residual debugging.

Definition at line 71 of file MechanicsActionPD.h.

Referenced by act(), and MechanicsActionPD().

◆ _stabilization

const MooseEnum MechanicsActionPD::_stabilization
protected

Option of stabilization scheme for correspondence material model (non-ordinary state based): FORCE or SELF.

Definition at line 55 of file MechanicsActionPD.h.

Referenced by getKernelName().

◆ _strain

const MooseEnum MechanicsActionPD::_strain
protected

Option of strain formulation: SMALL or FINITE.

Definition at line 58 of file MechanicsActionPD.h.

Referenced by act(), and getKernelName().

◆ _subdomain_id_union

std::set<SubdomainID> MechanicsActionPD::_subdomain_id_union
protected

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

Definition at line 68 of file MechanicsActionPD.h.

Referenced by act().

◆ _subdomain_ids

std::set<SubdomainID> MechanicsActionPD::_subdomain_ids
protected

set of subdomain IDs generated from the passed in vector of subdomain names

Definition at line 64 of file MechanicsActionPD.h.

Referenced by act().

◆ _subdomain_names

std::vector<SubdomainName> MechanicsActionPD::_subdomain_names
protected

vector of subdomain names from provided blocks

Definition at line 61 of file MechanicsActionPD.h.

Referenced by act().


The documentation for this class was generated from the following files:
MechanicsActionPD::_ndisp
const unsigned int _ndisp
Definition: MechanicsActionPD.h:46
MechanicsActionPD::_subdomain_names
std::vector< SubdomainName > _subdomain_names
vector of subdomain names from provided blocks
Definition: MechanicsActionPD.h:61
MechanicsActionPD::getKernelName
virtual std::string getKernelName()
Function to get the kernel name based on the value of member variables: _formulation and _stabilizati...
Definition: MechanicsActionPD.C:186
MechanicsActionPD::_save_in
std::vector< AuxVariableName > _save_in
Residual debugging.
Definition: MechanicsActionPD.h:71
MechanicsActionPD::_subdomain_id_union
std::set< SubdomainID > _subdomain_id_union
set of SubdomainID generated from the combined block restrictions of all TensorMechanics/Master actio...
Definition: MechanicsActionPD.h:68
MechanicsActionPD::_formulation
const MooseEnum _formulation
Option of which peridynamic model needs to be setup: BOND, ORDINARY_STATE or NONORDINARY_STATE.
Definition: MechanicsActionPD.h:51
MechanicsActionPD::getKernelParameters
virtual InputParameters getKernelParameters(std::string name)
Function to get the input parameters for a given kernel name.
Definition: MechanicsActionPD.C:217
MechanicsActionPD::_displacements
std::vector< VariableName > _displacements
Displacement variables.
Definition: MechanicsActionPD.h:45
MechanicsActionPD::_strain
const MooseEnum _strain
Option of strain formulation: SMALL or FINITE.
Definition: MechanicsActionPD.h:58
name
const std::string name
Definition: Setup.h:21
MechanicsActionPD::_subdomain_ids
std::set< SubdomainID > _subdomain_ids
set of subdomain IDs generated from the passed in vector of subdomain names
Definition: MechanicsActionPD.h:64
MechanicsActionPD::_diag_save_in
std::vector< AuxVariableName > _diag_save_in
Definition: MechanicsActionPD.h:72
MechanicsActionPD
Action class to setup peridynamic models for solid mechanics problems.
Definition: MechanicsActionPD.h:22
MechanicsActionPD::_stabilization
const MooseEnum _stabilization
Option of stabilization scheme for correspondence material model (non-ordinary state based): FORCE or...
Definition: MechanicsActionPD.h:55