#include <GlobalStrainAction.h>

Inheritance diagram for GlobalStrainAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	GlobalStrainAction (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 *	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
std::vector< VariableName >	_disp

std::vector< AuxVariableName >	_aux_disp

std::vector< AuxVariableName >	_global_disp

std::vector< SubdomainName >	_block_names

std::set< SubdomainID >	_block_ids

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 GlobalStrainAction.h.

Constructor & Destructor Documentation

◆ GlobalStrainAction()

GlobalStrainAction::GlobalStrainAction ( const InputParameters & params )

Definition at line 53 of file GlobalStrainAction.C.

   : Action(params),
     _disp(getParam<std::vector<VariableName>>("displacements")),
     _aux_disp(getParam<std::vector<AuxVariableName>>("auxiliary_displacements")),
     _global_disp(getParam<std::vector<AuxVariableName>>("global_displacements")),
     _block_names(getParam<std::vector<SubdomainName>>("block")),
     _block_ids()
 {
   if (_aux_disp.size() != _disp.size())
     mooseError("Number of auxiliary displacement variables should be equal to the number of "
                "nonlinear displacement variables, i.e., ",
                _disp.size());
 }

Member Function Documentation

◆ act()

void GlobalStrainAction::act ( )

overridevirtual

Implements Action.

Definition at line 68 of file GlobalStrainAction.C.

 {
   // get subdomain IDs
   for (auto & name : _block_names)
     _block_ids.insert(_problem->mesh().getSubdomainID(name));
 
   // user object name
   const std::string uo_name = _name + "_GlobalStrainUserObject";
 
   //
   // Add user object
   //
   if (_current_task == "add_user_object")
   {
     std::string uo_type = "GlobalStrainUserObject";
     InputParameters params = _factory.getValidParams(uo_type);
     params.applyParameters(parameters());
     params.set<bool>("use_displaced_mesh") = false;
     params.set<ExecFlagEnum>("execute_on") = {EXEC_INITIAL, EXEC_LINEAR, EXEC_NONLINEAR};
 
     _problem->addUserObject(uo_type, uo_name, params);
   }
 
   //
   // Add scalar kernel
   //
   else if (_current_task == "add_scalar_kernel")
   {
     std::string sk_type = "GlobalStrain";
     InputParameters params = _factory.getValidParams(sk_type);
     params.applyParameters(parameters());
     params.set<bool>("use_displaced_mesh") = false;
     params.set<NonlinearVariableName>("variable") = getParam<VariableName>("scalar_global_strain");
     params.set<UserObjectName>("global_strain_uo") = uo_name;
 
     _problem->addScalarKernel(sk_type, _name + "_GlobalStrain", params);
   }
 
   //
   // Add ComputeGlobalStrain material
   //
   else if (_current_task == "add_material")
   {
     std::string mat_type = "ComputeGlobalStrain";
     InputParameters params = _factory.getValidParams(mat_type);
     params.applyParameters(parameters(), {"scalar_global_strain"});
     params.set<bool>("use_displaced_mesh") = false;
     params.set<std::vector<VariableName>>("scalar_global_strain") = {
         getParam<VariableName>("scalar_global_strain")};
     params.set<UserObjectName>("global_strain_uo") = uo_name;
 
     _problem->addMaterial(mat_type, _name + "_global_strain", params);
   }
 
   //
   // Add auxiliary displacement variables
   //
   else if (_current_task == "add_aux_variable")
   {
     auto params = _factory.getValidParams("MooseVariable");
     // determine necessary order
     const bool second = _problem->mesh().hasSecondOrderElements();
 
     params.set<MooseEnum>("order") = second ? "SECOND" : "FIRST";
     params.set<MooseEnum>("family") = "LAGRANGE";
 
     for (unsigned int i = 0; i < _aux_disp.size(); ++i)
     {
       std::string aux_var_name = _aux_disp[i];
 
       _problem->addAuxVariable("MooseVariable", aux_var_name, params);
     }
 
     for (unsigned int i = 0; i < _global_disp.size(); ++i)
     {
       std::string aux_var_name = _global_disp[i];
 
       _problem->addAuxVariable("MooseVariable", aux_var_name, params);
     }
   }
 
   //
   // Add aux kernels for computing global displacements
   //
   else if (_current_task == "add_aux_kernel")
   {
     for (unsigned int i = 0; i < _aux_disp.size(); ++i)
     {
       std::string aux_var_name = _aux_disp[i];
 
       std::string aux_type = "GlobalDisplacementAux";
       InputParameters params = _factory.getValidParams(aux_type);
       params.applyParameters(parameters(), {"scalar_global_strain"});
       params.set<AuxVariableName>("variable") = aux_var_name;
       params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
       params.set<bool>("use_displaced_mesh") = false;
       params.set<bool>("output_global_displacement") = false;
       params.set<std::vector<VariableName>>("scalar_global_strain") = {
           getParam<VariableName>("scalar_global_strain")};
       params.set<UserObjectName>("global_strain_uo") = uo_name;
       params.set<unsigned int>("component") = i;
 
       _problem->addAuxKernel(aux_type, aux_var_name + '_' + name(), params);
     }
 
     for (unsigned int i = 0; i < _global_disp.size(); ++i)
     {
       std::string aux_var_name = _global_disp[i];
 
       std::string aux_type = "GlobalDisplacementAux";
       InputParameters params = _factory.getValidParams(aux_type);
       params.applyParameters(parameters(), {"scalar_global_strain"});
       params.set<AuxVariableName>("variable") = aux_var_name;
       params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
       params.set<bool>("use_displaced_mesh") = false;
       params.set<bool>("output_global_displacement") = true;
       params.set<std::vector<VariableName>>("scalar_global_strain") = {
           getParam<VariableName>("scalar_global_strain")};
       params.set<UserObjectName>("global_strain_uo") = uo_name;
       params.set<unsigned int>("component") = i;
 
       _problem->addAuxKernel(aux_type, aux_var_name + '_' + name(), params);
     }
   }
 }

◆ validParams()

InputParameters GlobalStrainAction::validParams ( )

static

Definition at line 30 of file GlobalStrainAction.C.

 {
   InputParameters params = Action::validParams();
   params.addClassDescription("Set up the GlobalStrainAction environment");
   params.addRequiredParam<VariableName>("scalar_global_strain",
                                         "Scalar variable for global strain");
   params.addParam<std::vector<VariableName>>("displacements", {}, "The displacement variables");
   params.addParam<std::vector<AuxVariableName>>(
       "auxiliary_displacements",
       "The auxliary displacement variables to be calculated from scalar variables");
   params.addParam<std::vector<AuxVariableName>>(
       "global_displacements",
       "The global displacement variables to be calculated from scalar variables");
   params.addParam<std::vector<Real>>("applied_stress_tensor",
                                      "Vector of values defining the constant applied stress "
                                      "to add, in order 11, 22, 33, 23, 13, 12");
   params.addParam<std::string>("base_name", "Material property base name");
   params.addParam<std::vector<SubdomainName>>(
       "block", {}, "The block id where this variable lives");
 
   return params;
 }

Member Data Documentation

◆ _aux_disp

std::vector<AuxVariableName> GlobalStrainAction::_aux_disp

protected

Definition at line 25 of file GlobalStrainAction.h.

Referenced by act(), and GlobalStrainAction().

◆ _block_ids

std::set<SubdomainID> GlobalStrainAction::_block_ids

protected

Definition at line 29 of file GlobalStrainAction.h.

Referenced by act().

◆ _block_names

std::vector<SubdomainName> GlobalStrainAction::_block_names

protected

Definition at line 28 of file GlobalStrainAction.h.

Referenced by act().

◆ _disp

std::vector<VariableName> GlobalStrainAction::_disp

protected

Definition at line 24 of file GlobalStrainAction.h.

Referenced by GlobalStrainAction().

◆ _global_disp

std::vector<AuxVariableName> GlobalStrainAction::_global_disp

protected

Definition at line 26 of file GlobalStrainAction.h.

Referenced by act().

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

solid_mechanics/include/actions/GlobalStrainAction.h
solid_mechanics/src/actions/GlobalStrainAction.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

◆ GlobalStrainAction()

Member Function Documentation

◆ act()

◆ validParams()

Member Data Documentation

◆ _aux_disp

◆ _block_ids

◆ _block_names

◆ _disp

◆ _global_disp