Action class to setup peridynamic generalized plane strain models. More...

#include <GeneralizedPlaneStrainActionPD.h>

Inheritance diagram for GeneralizedPlaneStrainActionPD:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	GeneralizedPlaneStrainActionPD (const InputParameters &params)

virtual void	act () override

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)

MooseApp &	getMooseApp () 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 InputParameters &	parameters () 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

T	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

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

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 MooseEnum	_formulation
	Option to choose which peridynamic model to use for generalized plane strain formulation: ordinary state based or non-ordinary state based. More...

VariableName	_scalar_out_of_plane_strain
	Scalar variable for out-of-plane strain variable. More...

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


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

const unsigned int	_ndisp

Detailed Description

Action class to setup peridynamic generalized plane strain models.

Definition at line 18 of file GeneralizedPlaneStrainActionPD.h.

Constructor & Destructor Documentation

◆ GeneralizedPlaneStrainActionPD()

GeneralizedPlaneStrainActionPD::GeneralizedPlaneStrainActionPD ( const InputParameters & params )

Definition at line 57 of file GeneralizedPlaneStrainActionPD.C.

   : Action(params),
     _displacements(getParam<std::vector<VariableName>>("displacements")),
     _ndisp(_displacements.size()),
     _formulation(getParam<MooseEnum>("formulation")),
     _scalar_out_of_plane_strain(getParam<VariableName>("scalar_out_of_plane_strain"))
 {
   // Generalized plane strain only applies to two dimensional modeling and simulation
   if (_ndisp != 2)
     mooseError("GeneralizedPlaneStrainPD only works for two dimensional case!");
 
   // Consistency check
   if (_formulation == "NONORDINARY_STATE" && isParamValid("out_of_plane_stress_variable"))
     mooseWarning("Variable out_of_plane_stress_variable will not be used in NONORDINARY_STATE "
                  "formulation option!");
   if (_formulation == "ORDINARY_STATE" && !isParamValid("out_of_plane_stress_variable"))
     mooseError("Variable out_of_plane_stress_variable must be provided for ORDINARY_STATE "
                "formulation option!");
 }

Member Function Documentation

◆ act()

void GeneralizedPlaneStrainActionPD::act ( )

overridevirtual

Implements Action.

Definition at line 78 of file GeneralizedPlaneStrainActionPD.C.

 {
   if (_current_task == "add_kernel")
   {
     std::string k_type;
     if (_formulation == "ORDINARY_STATE")
       k_type = "GeneralizedPlaneStrainOffDiagOSPD"; // Based on the ordinary state-based model
     else if (_formulation == "NONORDINARY_STATE")
       k_type = "GeneralizedPlaneStrainOffDiagNOSPD"; // Based on Form I of horizon-stabilized
                                                      // correspondence model
     else
       paramError("formulation", "Unsupported peridynamic formulation");
 
     InputParameters params = _factory.getValidParams(k_type);
 
     params.applyParameters(parameters(),
                            {"displacements", "temperature", "scalar_out_of_plane_strain"});
 
     params.set<std::vector<VariableName>>("displacements") = _displacements;
     params.set<std::vector<VariableName>>("scalar_out_of_plane_strain") = {
         _scalar_out_of_plane_strain};
 
     // Coupling between scalar out-of-plane strain and in-plane displacements
     for (unsigned int i = 0; i < _ndisp; ++i)
     {
       std::string k_name = name() + "_GeneralizedPlaneStrainPDOffDiag_disp_" + Moose::stringify(i);
       params.set<NonlinearVariableName>("variable") = _displacements[i];
 
       _problem->addKernel(k_type, k_name, params);
     }
 
     // Coupling between scalar out-of-plane strain and temperature (only when temperature is a
     // nonlinear variable)
     if (isParamValid("temperature"))
     {
       VariableName temp = getParam<VariableName>("temperature");
       if (_problem->getNonlinearSystemBase(/*nl_sys_num=*/0).hasVariable(temp))
       {
         params.set<std::vector<VariableName>>("temperature") = {temp};
 
         std::string k_name = name() + "_GeneralizedPlaneStrainPDOffDiag_temp";
         params.set<NonlinearVariableName>("variable") = temp;
 
         if (_formulation == "NONORDINARY_STATE")
           params.set<std::vector<MaterialPropertyName>>("eigenstrain_names") =
               getParam<std::vector<MaterialPropertyName>>("eigenstrain_names");
 
         _problem->addKernel(k_type, k_name, params);
       }
     }
   }
   else if (_current_task == "add_user_object")
   {
     std::string uo_type;
     if (_formulation == "ORDINARY_STATE")
       uo_type = "GeneralizedPlaneStrainUserObjectOSPD";
     else if (_formulation == "NONORDINARY_STATE")
       uo_type = "GeneralizedPlaneStrainUserObjectNOSPD";
     else
       paramError("formulation", "Unsupported peridynamic formulation!");
 
     InputParameters params = _factory.getValidParams(uo_type);
 
     std::string uo_name = name() + "_GeneralizedPlaneStrainPDUserObject";
 
     params.applyParameters(parameters(), {"out_of_plane_stress_variable"});
 
     if (_formulation == "ORDINARY_STATE")
       params.set<std::vector<VariableName>>("out_of_plane_stress_variable") = {
           getParam<VariableName>("out_of_plane_stress_variable")};
 
     _problem->addUserObject(uo_type, uo_name, params);
   }
   else if (_current_task == "add_scalar_kernel")
   {
     std::string sk_type("GeneralizedPlaneStrainPD");
     InputParameters params = _factory.getValidParams(sk_type);
 
     std::string sk_name = name() + "_GeneralizedPlaneStrainPD";
 
     params.set<NonlinearVariableName>("variable") = _scalar_out_of_plane_strain;
 
     // set the UserObjectName using added UserObject
     params.set<UserObjectName>("generalized_plane_strain_uo") =
         name() + "_GeneralizedPlaneStrainPDUserObject";
 
     _problem->addScalarKernel(sk_type, sk_name, params);
   }
   else
     mooseError("Task error in GeneralizedPlaneStrainActionPD!");
 }

◆ validParams()

InputParameters GeneralizedPlaneStrainActionPD::validParams ( )

static

Definition at line 21 of file GeneralizedPlaneStrainActionPD.C.

 {
   InputParameters params = Action::validParams();
   params.addClassDescription("Class for setting up the Kernel, ScalarKernel, and UserObject for "
                              "peridynamic generalized plane strain model");
 
   params.addRequiredParam<std::vector<VariableName>>(
       "displacements", "Nonlinear variable name for the displacements");
   params.addRequiredParam<VariableName>("scalar_out_of_plane_strain",
                                         "Scalar variable for strain in the out-of-plane direction");
   params.addParam<VariableName>("temperature", "Nonlinear variable for the temperature");
   MooseEnum formulation_option("ORDINARY_STATE NONORDINARY_STATE", "NONORDINARY_STATE");
   params.addParam<MooseEnum>("formulation", formulation_option, "Peridynamic formulation options");
   MooseEnum strain_type("SMALL FINITE", "SMALL");
   params.addParam<MooseEnum>("strain", strain_type, "Strain formulation");
   params.addParam<VariableName>("out_of_plane_stress_variable",
                                 "Name of out-of-plane stress auxiliary variable");
   params.addParam<FunctionName>(
       "out_of_plane_pressure",
       "0",
       "Function used to prescribe pressure in the out-of-plane direction");
   params.addParam<Real>("factor", 1.0, "Scale factor applied to prescribed out-of-plane pressure");
   params.addParam<bool>("full_jacobian",
                         false,
                         "Parameter to set whether to use the nonlocal full Jacobian formulation "
                         "for the scalar components");
   params.addParam<std::vector<SubdomainName>>("block",
                                               "List of ids of the blocks (subdomains) that the "
                                               "GeneralizedPlaneStrainActionPD will be applied "
                                               "to");
   params.addParam<std::vector<MaterialPropertyName>>(
       "eigenstrain_names", {}, "List of eigenstrains to be applied in this strain calculation");
 
   return params;
 }