#include <GeneralizedPlaneStrainAction.h>

Inheritance diagram for GeneralizedPlaneStrainAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	GeneralizedPlaneStrainAction (const InputParameters &params)

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 &	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

PerfGraph &	perfGraph ()

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &name, const std::string *param=nullptr) const

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
std::vector< VariableName >	_displacements

unsigned int	_ndisp
	Number of displacement variables. More...

const unsigned int	_out_of_plane_direction

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

Detailed Description

Definition at line 14 of file GeneralizedPlaneStrainAction.h.

Constructor & Destructor Documentation

◆ GeneralizedPlaneStrainAction()

GeneralizedPlaneStrainAction::GeneralizedPlaneStrainAction ( const InputParameters & params )

Definition at line 73 of file GeneralizedPlaneStrainAction.C.

   : Action(params),
     _displacements(getParam<std::vector<VariableName>>("displacements")),
     _ndisp(_displacements.size()),
     _out_of_plane_direction(getParam<MooseEnum>("out_of_plane_direction"))
 {
 }

Member Function Documentation

◆ act()

void GeneralizedPlaneStrainAction::act ( )

overridevirtual

Implements Action.

Definition at line 82 of file GeneralizedPlaneStrainAction.C.

 {
   // user object name
   const std::string uo_name = _name + "_GeneralizedPlaneStrainUserObject";
 
   //
   // Add off diagonal Jacobian kernels
   //
   if (_current_task == "add_kernel")
   {
     std::string k_type = "GeneralizedPlaneStrainOffDiag";
     InputParameters params = _factory.getValidParams(k_type);
 
     params.applyParameters(parameters(), {"scalar_out_of_plane_strain"});
     params.set<std::vector<VariableName>>("scalar_out_of_plane_strain") = {
         getParam<VariableName>("scalar_out_of_plane_strain")};
 
     // add off-diagonal jacobian kernels for the displacements
     for (unsigned int i = 0; i < _ndisp; ++i)
     {
       if (_out_of_plane_direction == i)
         continue;
 
       std::string k_name = _name + "GeneralizedPlaneStrainOffDiag_disp" + Moose::stringify(i);
       params.set<NonlinearVariableName>("variable") = _displacements[i];
 
       _problem->addKernel(k_type, k_name, params);
     }
 
     // add temperature kernel only if temperature is a nonlinear variable (and not an auxvariable)
     if (isParamValid("temperature"))
     {
       auto temp = getParam<std::vector<VariableName>>("temperature");
       if (temp.size() > 1)
         mooseError("Only one variable may be specified in 'temperature'");
       if (_problem->getNonlinearSystemBase(/*nl_sys_num=*/0).hasVariable(temp[0]))
       {
         std::string k_name = _name + "_GeneralizedPlaneStrainOffDiag_temp";
         params.set<NonlinearVariableName>("variable") = temp[0];
 
         _problem->addKernel(k_type, k_name, params);
       }
     }
   }
 
   //
   // Add user object
   //
   else if (_current_task == "add_user_object")
   {
     std::string uo_type = "GeneralizedPlaneStrainUserObject";
     InputParameters params = _factory.getValidParams(uo_type);
 
     // Skipping selected parameters in applyParameters() and then manually setting them only if they
     // are set by the user is just to prevent both the current and deprecated variants of these
     // parameters from both getting passed to the UserObject. Once we get rid of the deprecated
     // versions, we can just set them all with applyParameters().
     params.applyParameters(
         parameters(),
         {"out_of_plane_pressure", "out_of_plane_pressure_function", "factor", "pressure_factor"});
     if (parameters().isParamSetByUser("out_of_plane_pressure"))
       params.set<FunctionName>("out_of_plane_pressure") =
           getParam<FunctionName>("out_of_plane_pressure");
     if (parameters().isParamSetByUser("out_of_plane_pressure_function"))
       params.set<FunctionName>("out_of_plane_pressure_function") =
           getParam<FunctionName>("out_of_plane_pressure_function");
     if (parameters().isParamSetByUser("factor"))
       params.set<Real>("factor") = getParam<Real>("factor");
     if (parameters().isParamSetByUser("pressure_factor"))
       params.set<Real>("pressure_factor") = getParam<Real>("pressure_factor");
 
     _problem->addUserObject(uo_type, uo_name, params);
   }
 
   //
   // Add scalar kernel
   //
   else if (_current_task == "add_scalar_kernel")
   {
     std::string sk_type = "GeneralizedPlaneStrain";
     InputParameters params = _factory.getValidParams(sk_type);
 
     params.set<NonlinearVariableName>("variable") =
         getParam<VariableName>("scalar_out_of_plane_strain");
 
     // set the UserObjectName from previously added UserObject
     params.set<UserObjectName>("generalized_plane_strain") = uo_name;
 
     if (isParamValid("extra_vector_tags"))
       params.set<std::vector<TagName>>("extra_vector_tags") =
           getParam<std::vector<TagName>>("extra_vector_tags");
     if (isParamValid("absolute_value_vector_tags"))
       params.set<std::vector<TagName>>("absolute_value_vector_tags") =
           getParam<std::vector<TagName>>("absolute_value_vector_tags");
 
     _problem->addScalarKernel(sk_type, _name + "_GeneralizedPlaneStrain", params);
   }
 }

◆ validParams()

InputParameters GeneralizedPlaneStrainAction::validParams ( )

static

Definition at line 24 of file GeneralizedPlaneStrainAction.C.

 {
   InputParameters params = Action::validParams();
   params.addClassDescription("Set up the GeneralizedPlaneStrain environment");
   params.addRequiredParam<std::vector<VariableName>>("displacements", "The displacement variables");
   params.addRequiredParam<VariableName>("scalar_out_of_plane_strain",
                                         "Scalar variable for the out-of-plane strain (in "
                                         "y direction for 1D Axisymmetric or in z "
                                         "direction for 2D Cartesian problems)");
   params.addParam<std::vector<VariableName>>("temperature", "The temperature variable");
   MooseEnum outOfPlaneDirection("x y z", "z");
   params.addParam<MooseEnum>(
       "out_of_plane_direction", outOfPlaneDirection, "The direction of the out-of-plane strain.");
   params.addParam<FunctionName>(
       "out_of_plane_pressure_function",
       "Function used to prescribe pressure (applied toward the body) in the out-of-plane direction "
       "(y for 1D Axisymmetric or z for 2D Cartesian problems)");
   params.addDeprecatedParam<FunctionName>(
       "out_of_plane_pressure",
       "Function used to prescribe pressure (applied toward the body) in the out-of-plane direction "
       "(y for 1D Axisymmetric or z for 2D Cartesian problems)",
       "This has been replaced by 'out_of_plane_pressure_function'");
   params.addParam<MaterialPropertyName>("out_of_plane_pressure_material",
                                         "0",
                                         "Material used to prescribe pressure (applied toward the "
                                         "body) in the out-of-plane direction");
   params.addDeprecatedParam<Real>(
       "factor",
       "Scale factor applied to prescribed out-of-plane pressure (both material and function)",
       "This has been replaced by 'pressure_factor'");
   params.addParam<Real>(
       "pressure_factor",
       "Scale factor applied to prescribed out-of-plane pressure (both material and function)");
   params.addParam<bool>("use_displaced_mesh", false, "Whether to use displaced mesh");
   params.addParam<std::string>("base_name", "Material property base name");
   params.addParam<std::vector<SubdomainName>>("block",
                                               "The list of ids of the blocks (subdomain) "
                                               "that the GeneralizedPlaneStrain kernels "
                                               "will be applied to");
   params.addParam<std::vector<TagName>>(
       "extra_vector_tags",
       "The tag names for extra vectors that residual data should be saved into");
   params.addParam<std::vector<TagName>>("absolute_value_vector_tags",
                                         "The tag names for extra vectors that the absolute value "
                                         "of the residual should be accumulated into");
 
   return params;
 }

Member Data Documentation

◆ _displacements

std::vector<VariableName> GeneralizedPlaneStrainAction::_displacements

protected

Definition at line 24 of file GeneralizedPlaneStrainAction.h.

Referenced by act().

◆ _ndisp

unsigned int GeneralizedPlaneStrainAction::_ndisp

protected

Number of displacement variables.

Definition at line 27 of file GeneralizedPlaneStrainAction.h.

Referenced by act().

◆ _out_of_plane_direction

const unsigned int GeneralizedPlaneStrainAction::_out_of_plane_direction

protected

Definition at line 28 of file GeneralizedPlaneStrainAction.h.

Referenced by act().

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

solid_mechanics/include/actions/GeneralizedPlaneStrainAction.h
solid_mechanics/src/actions/GeneralizedPlaneStrainAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GeneralizedPlaneStrainAction()

Member Function Documentation

◆ act()

◆ validParams()

Member Data Documentation

◆ _displacements

◆ _ndisp

◆ _out_of_plane_direction