#include <LineElementAction.h>

Inheritance diagram for LineElementAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	LineElementAction (const InputParameters &params)

virtual void	act ()

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

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () 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 &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (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

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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 ()

static InputParameters	beamParameters ()
	Add parameters required for a beam element.

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Types
enum class	Strain { SMALL , FINITE }
	strain formulation More...

Protected Member Functions
void	actGatherActionParameters ()
	Gather all the block ids from all the actions of this type to create variables spanning all the blocks.

void	actAddVariables ()
	Adds displacement and rotation variables.

void	actAddMaterials ()
	Adds material objects required for beam and truss elements.

void	actAddKernels ()
	Adds StressDivergence kernels for beam and truss elements and inertia kernels for dynamic beam simulations.

void	actAddAuxVariables ()
	Adds translational and rotational velocity and acceleration aux variables for dynamic beam simulations.

void	actAddAuxKernels ()
	Adds auxkernels corresponding to the translational and rotational velocity and acceleration aux variables.

void	actAddNodalKernels ()
	Adds nodal kernels that calculate inertial force/torque due to mass/inertia assigned to nodes of the beam.

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::vector< VariableName >	_displacements
	Names of displacement variables.

unsigned int	_ndisp
	Number of displacement variables.

std::vector< VariableName >	_rotations
	Names of rotational variables for beam element.

std::vector< VariableName >	_velocities
	Names of translational velocity variables for dynamic simulation using beam element.

std::vector< VariableName >	_accelerations
	Names of translational acceleration variables for dynamic simulation beam element.

std::vector< VariableName >	_rot_velocities
	Names of rotational velocity variables for dynamic simulation using beam element.

std::vector< VariableName >	_rot_accelerations
	Names of rotational acceleration variables for dynamic simulation beam element.

std::vector< SubdomainName >	_subdomain_names
	If this vector is not empty the variables, auxvariables, kernels, auxkernels, nodalkernels and materials are restricted to these subdomains.

std::set< SubdomainID >	_subdomain_ids
	set generated from the passed in vector of subdomain names

std::set< SubdomainID >	_subdomain_id_union
	set generated from the combined block restrictions of all LineElementAction action blocks

enum LineElementAction::Strain	_strain_type

Strain	_rotation_type

bool	_use_displaced_mesh
	use displaced mesh (true unless _strain is SMALL_STRAIN_AND_ROTATION)

bool	_add_dynamic_variables
	Set to true to set up translational and acceleration AuxVariables and the corresponding AuxKernels using the action when the dynamic kernels or nodal kernels are not set by the action.

bool	_dynamic_consistent_inertia
	Set to true to use consistent mass and inertia matrices to calculate inertial forces/torques in dynamic beam simulations.

bool	_dynamic_nodal_translational_inertia
	Set to true to use nodal mass matrix to calculate inertial forces in dynamic beam simulations.

bool	_dynamic_nodal_rotational_inertia
	Set to true to use nodal inertia matrix to calculate inertial torques in dynamic beam simulations.

bool	_truss
	Set to true if line element is a truss.

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

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator


std::vector< AuxVariableName >	_save_in
	residual debugging

std::vector< AuxVariableName >	_diag_save_in

Private Member Functions
bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

Detailed Description

Definition at line 14 of file LineElementAction.h.

Member Enumeration Documentation

◆ Strain

enum class LineElementAction::Strain

strongprotected

strain formulation

Enumerator
SMALL
FINITE

Definition at line 117 of file LineElementAction.h.

  {
    SMALL,
    FINITE
  } _strain_type;

Constructor & Destructor Documentation

◆ LineElementAction()

LineElementAction::LineElementAction ( const InputParameters & params )

Definition at line 204 of file LineElementAction.C.

  : Action(params),
    _rotations(0),
    _velocities(0),
    _accelerations(0),
    _rot_velocities(0),
    _rot_accelerations(0),
    _subdomain_names(getParam<std::vector<SubdomainName>>("block")),
    _subdomain_ids(),
    _add_dynamic_variables(false)
{
  // FIXME: suggest to use action of action to add this to avoid changing the input parameters in
  // the warehouse.
  const auto & parameters = _app.getInputParameterWarehouse().getInputParameters();
  InputParameters & pars(*(parameters.find(uniqueActionName())->second.get()));
 
  // check if a container block with common parameters is found
  auto action = _awh.getActions<CommonLineElementAction>();
  if (action.size() == 1)
    pars.applyParameters(action[0]->parameters());
 
  // Set values to variables after common parameters are applied
  _save_in = getParam<std::vector<AuxVariableName>>("save_in");
  _diag_save_in = getParam<std::vector<AuxVariableName>>("diag_save_in");
  _strain_type = getParam<MooseEnum>("strain_type").getEnum<Strain>();
  _rotation_type = getParam<MooseEnum>("rotation_type").getEnum<Strain>();
  _dynamic_consistent_inertia = getParam<bool>("dynamic_consistent_inertia");
  _dynamic_nodal_translational_inertia = getParam<bool>("dynamic_nodal_translational_inertia");
  _dynamic_nodal_rotational_inertia = getParam<bool>("dynamic_nodal_rotational_inertia");
  if (_dynamic_consistent_inertia || _dynamic_nodal_rotational_inertia ||
      _dynamic_nodal_translational_inertia)
    _add_dynamic_variables = true;
 
  if (params.isParamSetByUser("add_dynamic_variables"))
  {
    bool user_defined_add_dynamic_variables = getParam<bool>("add_dynamic_variables");
    if (!_add_dynamic_variables && user_defined_add_dynamic_variables)
      _add_dynamic_variables = true;
    else if (_add_dynamic_variables && !user_defined_add_dynamic_variables)
      mooseError("LineElementAction: When using 'dynamic_consistent_inertia', "
                 "'dynamic_nodal_rotational_inertia' or '_dynamic_nodal_translational_inertia', "
                 "the velocity and acceleration AuxVariables and the corresponding AuxKernels are "
                 "automatically set by the action and this cannot be turned off by setting "
                 "'add_dynamic_variables' to false.");
  }
  _truss = getParam<bool>("truss");
 
  if (!isParamValid("displacements"))
    paramError("displacements",
               "LineElementAction: A vector of displacement variable names should be provided as "
               "input using `displacements`.");
 
  _displacements = getParam<std::vector<VariableName>>("displacements");
  _ndisp = _displacements.size();
 
  // determine if displaced mesh is to be used
  _use_displaced_mesh = (_strain_type != Strain::SMALL && _rotation_type != Strain::SMALL);
  if (params.isParamSetByUser("use_displaced_mesh"))
  {
    bool use_displaced_mesh_param = getParam<bool>("use_displaced_mesh");
    if (use_displaced_mesh_param != _use_displaced_mesh && params.isParamSetByUser("strain_type") &&
        params.isParamSetByUser("rotation_type"))
      paramError("use_displaced_mesh",
                 "LineElementAction: Wrong combination of "
                 "`use_displaced_mesh`, `strain_type` and `rotation_type`.");
    _use_displaced_mesh = use_displaced_mesh_param;
  }
 
  if (_save_in.size() != 0 && _save_in.size() != _ndisp)
    paramError("save_in",
               "LineElementAction: Number of save_in variables should equal to the number of "
               "displacement variables ",
               _ndisp);
 
  if (_diag_save_in.size() != 0 && _diag_save_in.size() != _ndisp)
    paramError("diag_save_in",
               "LineElementAction: Number of diag_save_in variables should equal to the number of "
               "displacement variables ",
               _ndisp);
 
  // Check if all the parameters required for static and dynamic beam simulation are provided as
  // input
  if (!_truss)
  {
    // Parameters required for static simulation using beams
    if (!isParamValid("rotations"))
      paramError("rotations",
                 "LineElementAction: Rotational variable names should be provided for beam "
                 "elements using `rotations` parameter.");
 
    _rotations = getParam<std::vector<VariableName>>("rotations");
 
    if (_rotations.size() != _ndisp)
      paramError("rotations",
                 "LineElementAction: Number of rotational and displacement variable names provided "
                 "as input for beam should be same.");
 
    if (!isParamValid("y_orientation") || !isParamValid("area") || !isParamValid("Iy") ||
        !isParamValid("Iz"))
      mooseError("LineElementAction: `y_orientation`, `area`, `Iy` and `Iz` should be provided for "
                 "beam elements.");
 
    // Parameters required for dynamic simulation using beams
    if (_add_dynamic_variables)
    {
      if (!isParamValid("velocities") || !isParamValid("accelerations") ||
          !isParamValid("rotational_velocities") || !isParamValid("rotational_accelerations"))
        mooseError(
            "LineElementAction: Variable names for translational and rotational velocities "
            "and accelerations should be provided as input to perform dynamic simulation "
            "using beam elements using `velocities`, `accelerations`, `rotational_velocities` and "
            "`rotational_accelerations`.");
 
      _velocities = getParam<std::vector<VariableName>>("velocities");
      _accelerations = getParam<std::vector<VariableName>>("accelerations");
      _rot_velocities = getParam<std::vector<VariableName>>("rotational_velocities");
      _rot_accelerations = getParam<std::vector<VariableName>>("rotational_accelerations");
 
      if (_velocities.size() != _ndisp || _accelerations.size() != _ndisp ||
          _rot_velocities.size() != _ndisp || _rot_accelerations.size() != _ndisp)
        mooseError("LineElementAction: Number of translational and rotational velocity and "
                   "acceleration variable names provided as input for the beam should be same as "
                   "number of displacement variables.");
 
      if (!isParamValid("beta") || !isParamValid("gamma"))
        mooseError("LineElementAction: Newmark time integration parameters `beta` and `gamma` "
                   "should be provided as input to perform dynamic simulations using beams.");
    }
 
    if (_dynamic_consistent_inertia && !isParamValid("density"))
      paramError("density",
                 "LineElementAction: Either name of the density material property or a constant "
                 "density value should be provided as input using `density` for creating the "
                 "consistent mass/inertia matrix required for dynamic beam simulation.");
 
    if (_dynamic_nodal_translational_inertia &&
        (!isParamValid("nodal_mass") && !isParamValid("nodal_mass_file")))
      paramError("nodal_mass",
                 "LineElementAction: `nodal_mass` or `nodal_mass_file` should be provided as input "
                 "to calculate "
                 "inertial forces on beam due to nodal mass.");
 
    if (_dynamic_nodal_rotational_inertia &&
        ((!isParamValid("nodal_Ixx") || !isParamValid("nodal_Iyy") || !isParamValid("nodal_Izz"))))
      mooseError("LineElementAction: `nodal_Ixx`, `nodal_Iyy`, `nodal_Izz` should be provided as "
                 "input to calculate inertial torque on beam due to nodal inertia.");
  }
  else // if truss
  {
    if (!isParamValid("area"))
      paramError("area",
                 "LineElementAction: `area` should be provided as input for "
                 "truss elements.");
 
    if (isParamValid("rotations"))
      paramError("rotations",
                 "LineElementAction: Rotational variables cannot be set for truss elements.");
  }
}

Member Function Documentation

◆ act()

void LineElementAction::act ( )

virtual

Implements Action.

Definition at line 365 of file LineElementAction.C.

{
  // Get the subdomain involved in the action once the mesh setup is complete
  if (_current_task == "create_problem")
  {
    // get subdomain IDs
    for (auto & name : _subdomain_names)
      _subdomain_ids.insert(_mesh->getSubdomainID(name));
  }
 
  if (_current_task == "add_variable")
  {
    //
    // Gather info from all other LineElementAction
    //
    actGatherActionParameters();
 
    //
    // Add variables (optional)
    //
    actAddVariables();
  }
 
  //
  // Add Materials - ComputeIncrementalBeamStrain or ComputeFiniteBeamStrain
  // for beam elements
  //
  if (_current_task == "add_material")
    actAddMaterials();
 
  //
  // Add Kernels - StressDivergenceBeam and InertialForceBeam (if dynamic_consistent_inertia is
  // turned on) for beams and StressDivergenceTensorsTruss for truss elements
  //
  if (_current_task == "add_kernel")
    actAddKernels();
 
  //
  // Add aux variables for translational and Rotational velocities and acceleration for dynamic
  // analysis using beams
  //
  if (_current_task == "add_aux_variable")
    actAddAuxVariables();
 
  //
  // Add NewmarkVelAux and NewarkAccelAux auxkernels for dynamic simulation using beams
  //
  if (_current_task == "add_aux_kernel")
    actAddAuxKernels();
 
  //
  // Add NodalKernels - NodalTranslationalInertia (if dynamic_nodal_translational_inertia is turned
  // on) and NodalRotattionalInertia (if dynamic_nodal_rotational_inertia) for dynamic simulations
  // using beams
  //
  if (_current_task == "add_nodal_kernel")
    actAddNodalKernels();
}

◆ actAddAuxKernels()

void LineElementAction::actAddAuxKernels ( )

protected

Adds auxkernels corresponding to the translational and rotational velocity and acceleration aux variables.

Definition at line 649 of file LineElementAction.C.

{
  if (_add_dynamic_variables && !_truss)
  {
    auto params = _factory.getValidParams("NewmarkAccelAux");
    params.applyParameters(parameters(), {"boundary"});
    params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
 
    for (unsigned i = 0; i < 2 * _ndisp; ++i)
    {
      std::string aux_kernel_name = name() + "_newmark_accel_" + Moose::stringify(i);
 
      if (i < _ndisp)
      {
        params.set<AuxVariableName>("variable") = _accelerations[i];
        params.set<std::vector<VariableName>>("velocity") = {_velocities[i]};
        params.set<std::vector<VariableName>>("displacement") = {_displacements[i]};
 
        _problem->addAuxKernel("NewmarkAccelAux", aux_kernel_name, params);
      }
      else
      {
        params.set<AuxVariableName>("variable") = _rot_accelerations[i - _ndisp];
        params.set<std::vector<VariableName>>("velocity") = {_rot_velocities[i - _ndisp]};
        params.set<std::vector<VariableName>>("displacement") = {_rotations[i - _ndisp]};
 
        _problem->addAuxKernel("NewmarkAccelAux", aux_kernel_name, params);
      }
    }
 
    params = _factory.getValidParams("NewmarkVelAux");
    params.applyParameters(parameters(), {"boundary"});
    params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
 
    for (unsigned i = 0; i < 2 * _ndisp; ++i)
    {
      std::string aux_kernel_name = name() + "_newmark_vel_" + Moose::stringify(i);
 
      if (i < _ndisp)
      {
        params.set<AuxVariableName>("variable") = _velocities[i];
        params.set<std::vector<VariableName>>("acceleration") = {_accelerations[i]};
        _problem->addAuxKernel("NewmarkVelAux", aux_kernel_name, params);
      }
      else
      {
        params.set<AuxVariableName>("variable") = _rot_velocities[i - _ndisp];
        params.set<std::vector<VariableName>>("acceleration") = {_rot_accelerations[i - _ndisp]};
        _problem->addAuxKernel("NewmarkVelAux", aux_kernel_name, params);
      }
    }
  }
}

Referenced by act().

◆ actAddAuxVariables()

void LineElementAction::actAddAuxVariables ( )

protected

Adds translational and rotational velocity and acceleration aux variables for dynamic beam simulations.

Definition at line 625 of file LineElementAction.C.

{
  if (_add_dynamic_variables && !_truss)
  {
    auto params = _factory.getValidParams("MooseVariable");
 
    params.set<MooseEnum>("order") = "FIRST";
    params.set<MooseEnum>("family") = "LAGRANGE";
 
    for (auto vel : _velocities)
      _problem->addAuxVariable("MooseVariable", vel, params);
 
    for (auto accel : _accelerations)
      _problem->addAuxVariable("MooseVariable", accel, params);
 
    for (auto rot_vel : _rot_velocities)
      _problem->addAuxVariable("MooseVariable", rot_vel, params);
 
    for (auto rot_accel : _rot_accelerations)
      _problem->addAuxVariable("MooseVariable", rot_accel, params);
  }
}

Referenced by act().

◆ actAddKernels()

void LineElementAction::actAddKernels ( )

protected

Adds StressDivergence kernels for beam and truss elements and inertia kernels for dynamic beam simulations.

Definition at line 523 of file LineElementAction.C.

{
  if (!_truss)
  {
    // add StressDivergenceBeam kernels
    auto params = _factory.getValidParams("StressDivergenceBeam");
    params.applyParameters(parameters(), {"use_displaced_mesh", "save_in", "diag_save_in"});
    params.set<bool>("use_displaced_mesh") = _use_displaced_mesh;
 
    for (unsigned int i = 0; i < 2 * _ndisp; ++i)
    {
      std::string kernel_name = name() + "_stress_divergence_beam_" + Moose::stringify(i);
 
      if (i < _ndisp)
      {
        params.set<unsigned int>("component") = i;
        params.set<NonlinearVariableName>("variable") = _displacements[i];
 
        if (_save_in.size() == 2 * _ndisp)
          params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
        if (_diag_save_in.size() == 2 * _ndisp)
          params.set<std::vector<AuxVariableName>>("diag_save_in") = {_diag_save_in[i]};
 
        _problem->addKernel("StressDivergenceBeam", kernel_name, params);
      }
      else
      {
        params.set<unsigned int>("component") = i;
        params.set<NonlinearVariableName>("variable") = _rotations[i - 3];
 
        if (_save_in.size() == 2 * _ndisp)
          params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
        if (_diag_save_in.size() == 2 * _ndisp)
          params.set<std::vector<AuxVariableName>>("diag_save_in") = {_diag_save_in[i]};
 
        _problem->addKernel("StressDivergenceBeam", kernel_name, params);
      }
    }
    // Add InertialForceBeam if dynamic simulation using consistent mass/inertia matrix has to be
    // performed
    if (_dynamic_consistent_inertia)
    {
      // add InertialForceBeam
      params = _factory.getValidParams("InertialForceBeam");
      params.applyParameters(parameters(), {"use_displaced_mesh", "save_in", "diag_save_in"});
      params.set<bool>("use_displaced_mesh") = _use_displaced_mesh;
 
      for (unsigned int i = 0; i < 2 * _ndisp; ++i)
      {
        std::string kernel_name = name() + "_inertial_force_beam_" + Moose::stringify(i);
 
        if (i < _ndisp)
        {
          params.set<unsigned int>("component") = i;
          params.set<NonlinearVariableName>("variable") = _displacements[i];
 
          if (_save_in.size() == 2 * _ndisp)
            params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
          if (_diag_save_in.size() == 2 * _ndisp)
            params.set<std::vector<AuxVariableName>>("diag_save_in") = {_diag_save_in[i]};
 
          _problem->addKernel("InertialForceBeam", kernel_name, params);
        }
        else
        {
          params.set<unsigned int>("component") = i;
          params.set<NonlinearVariableName>("variable") = _rotations[i - 3];
 
          if (_save_in.size() == 2 * _ndisp)
            params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
          if (_diag_save_in.size() == 2 * _ndisp)
            params.set<std::vector<AuxVariableName>>("diag_save_in") = {_diag_save_in[i]};
 
          _problem->addKernel("InertialForceBeam", kernel_name, params);
        }
      }
    }
  }
  else
  {
    // Add StressDivergenceTensorsTruss kernels
    auto params = _factory.getValidParams("StressDivergenceTensorsTruss");
    params.applyParameters(parameters(), {"use_displaced_mesh", "save_in", "diag_save_in"});
    params.set<bool>("use_displaced_mesh") = true;
 
    for (unsigned int i = 0; i < _ndisp; ++i)
    {
      std::string kernel_name = name() + "_stress_divergence_truss_" + Moose::stringify(i);
      params.set<unsigned int>("component") = i;
      params.set<NonlinearVariableName>("variable") = _displacements[i];
 
      if (_save_in.size() == _ndisp)
        params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
      if (_diag_save_in.size() == _ndisp)
        params.set<std::vector<AuxVariableName>>("diag_save_in") = {_diag_save_in[i]};
 
      _problem->addKernel("StressDivergenceTensorsTruss", kernel_name, params);
    }
  }
}

Referenced by act().

◆ actAddMaterials()

void LineElementAction::actAddMaterials ( )

protected

Adds material objects required for beam and truss elements.

Definition at line 492 of file LineElementAction.C.

{
  if (!_truss)
  {
    // Add Strain
    if (_rotation_type == Strain::SMALL)
    {
      auto params = _factory.getValidParams("ComputeIncrementalBeamStrain");
      params.applyParameters(parameters(), {"boundary", "use_displaced_mesh"});
      params.set<bool>("use_displaced_mesh") = false;
 
      if (_strain_type == Strain::FINITE)
        params.set<bool>("large_strain") = true;
 
      _problem->addMaterial("ComputeIncrementalBeamStrain", name() + "_strain", params);
    }
    else if (_rotation_type == Strain::FINITE)
    {
      auto params = _factory.getValidParams("ComputeFiniteBeamStrain");
      params.applyParameters(parameters(), {"boundary", "use_displaced_mesh"});
      params.set<bool>("use_displaced_mesh") = false;
 
      if (_strain_type == Strain::FINITE)
        params.set<bool>("large_strain") = true;
 
      _problem->addMaterial("ComputeFiniteBeamStrain", name() + "_strain", params);
    }
  }
}

Referenced by act().

◆ actAddNodalKernels()

void LineElementAction::actAddNodalKernels ( )

protected

Adds nodal kernels that calculate inertial force/torque due to mass/inertia assigned to nodes of the beam.

Definition at line 704 of file LineElementAction.C.

{
  if (!_truss)
  {
    // NodalTranslationalInertia and NodalRotattionalInertia currently accept only constant real
    // numbers for eta
    Real eta = 0.0;
    if (_dynamic_nodal_rotational_inertia || _dynamic_nodal_translational_inertia)
    {
      std::string ss(getParam<MaterialPropertyName>("eta"));
      Real real_value = MooseUtils::convert<Real>(ss);
 
      eta = real_value;
    }
 
    if (_dynamic_nodal_translational_inertia)
    {
      auto params = _factory.getValidParams("NodalTranslationalInertia");
      params.applyParameters(parameters(),
                             {"save_in", "diag_save_in", "use_displaced_mesh", "eta"});
      params.set<Real>("mass") = getParam<Real>("nodal_mass");
      params.set<Real>("eta") = eta;
      params.set<bool>("use_displaced_mesh") = _use_displaced_mesh;
 
      for (unsigned i = 0; i < _ndisp; ++i)
      {
        std::string nodal_kernel_name =
            name() + "_nodal_translational_inertia_" + Moose::stringify(i);
 
        params.set<NonlinearVariableName>("variable") = _displacements[i];
        params.set<std::vector<VariableName>>("velocity") = {_velocities[i]};
        params.set<std::vector<VariableName>>("acceleration") = {_accelerations[i]};
 
        if (_save_in.size() == 2 * _ndisp)
          params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
 
        if (_diag_save_in.size() == 2 * _ndisp)
          params.set<std::vector<AuxVariableName>>("diag_save_in") = {_diag_save_in[i]};
 
        _problem->addNodalKernel("NodalTranslationalInertia", nodal_kernel_name, params);
      }
    }
 
    if (_dynamic_nodal_rotational_inertia)
    {
      auto params = _factory.getValidParams("NodalRotationalInertia");
      params.applyParameters(parameters(),
                             {"save_in",
                              "diag_save_in",
                              "use_displaced_mesh",
                              "eta",
                              "x_orientation",
                              "y_orientation"});
      params.set<Real>("Ixx") = getParam<Real>("nodal_Ixx");
      params.set<Real>("Iyy") = getParam<Real>("nodal_Iyy");
      params.set<Real>("Izz") = getParam<Real>("nodal_Izz");
      params.set<Real>("eta") = eta;
      params.set<bool>("use_displaced_mesh") = _use_displaced_mesh;
 
      if (isParamValid("nodal_Ixy"))
        params.set<Real>("Ixy") = getParam<Real>("nodal_Ixy");
 
      if (isParamValid("nodal_Ixz"))
        params.set<Real>("Ixz") = getParam<Real>("nodal_Ixz");
 
      if (isParamValid("nodal_Iyz"))
        params.set<Real>("Iyz") = getParam<Real>("nodal_Iyz");
 
      if (isParamValid("nodal_x_orientation"))
        params.set<Real>("x_orientation") = getParam<Real>("nodal_x_orientation");
 
      if (isParamValid("nodal_y_orientation"))
        params.set<Real>("y_orientation") = getParam<Real>("nodal_y_orientation");
 
      for (unsigned i = 0; i < _ndisp; ++i)
      {
        std::string nodal_kernel_name = name() + "_nodal_rotational_inertia_" + Moose::stringify(i);
 
        params.set<unsigned int>("component") = i;
        params.set<NonlinearVariableName>("variable") = _rotations[i];
 
        if (_save_in.size() == 2 * _ndisp)
          params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i + _ndisp]};
 
        if (_diag_save_in.size() == 2 * _ndisp)
          params.set<std::vector<AuxVariableName>>("diag_save_in") = {_diag_save_in[i + _ndisp]};
 
        _problem->addNodalKernel("NodalRotationalInertia", nodal_kernel_name, params);
      }
    }
  }
}

Referenced by act().

◆ actAddVariables()

void LineElementAction::actAddVariables ( )

protected

Adds displacement and rotation variables.

Definition at line 455 of file LineElementAction.C.

{
  if (getParam<bool>("add_variables"))
  {
    auto params = _factory.getValidParams("MooseVariable");
 
    // determine order of elements in mesh
    const bool second = _problem->mesh().hasSecondOrderElements();
    if (second)
      mooseError("LineElementAction: Only linear truss and beam elements are currently supported. "
                 "Please change the order of elements in the mesh to use first order elements.");
 
    params.set<MooseEnum>("order") = "FIRST";
    params.set<MooseEnum>("family") = "LAGRANGE";
 
    // Loop through the displacement variables
    for (const auto & disp : _displacements)
    {
      // Create displacement variables
      if (!_problem->hasVariable(disp))
        _problem->addVariable("MooseVariable", disp, params);
    }
 
    // Add rotation variables if line element is a beam.
    if (!_truss)
    {
      for (const auto & rot : _rotations)
      {
        // Create rotation variables
        if (!_problem->hasVariable(rot))
          _problem->addVariable("MooseVariable", rot, params);
      }
    }
  }
}

Referenced by act().

◆ actGatherActionParameters()

void LineElementAction::actGatherActionParameters ( )

protected

Gather all the block ids from all the actions of this type to create variables spanning all the blocks.

Definition at line 425 of file LineElementAction.C.

{
  //
  // Gather info about all other master actions when we add variables
  //
  if (getParam<bool>("add_variables"))
  {
    auto actions = _awh.getActions<LineElementAction>();
    for (const auto & action : actions)
    {
      const auto size_before = _subdomain_id_union.size();
      const auto added_size = action->_subdomain_ids.size();
      _subdomain_id_union.insert(action->_subdomain_ids.begin(), action->_subdomain_ids.end());
      const auto size_after = _subdomain_id_union.size();
 
      if (size_after != size_before + added_size)
        paramError("block",
                   "LineElementAction: The block restrictions in the LineElement actions must be "
                   "non-overlapping.");
 
      if (added_size == 0 && actions.size() > 1)
        paramError(
            "block",
            "LineElementAction: No LineElement action can be block unrestricted if more than one "
            "LineElement action is specified.");
    }
  }
}

Referenced by act().

◆ beamParameters()

InputParameters LineElementAction::beamParameters ( )

static

Add parameters required for a beam element.

Definition at line 80 of file LineElementAction.C.

{
  InputParameters params = emptyInputParameters();
 
  params.addParam<std::vector<VariableName>>(
      "rotations", "The rotations appropriate for the simulation geometry and coordinate system");
 
  MooseEnum strainType("SMALL FINITE", "SMALL");
  params.addParam<MooseEnum>("strain_type", strainType, "Strain formulation");
  params.addParam<MooseEnum>("rotation_type", strainType, "Rotation formulation");
  params.addParam<std::vector<MaterialPropertyName>>(
      "eigenstrain_names", "List of beam eigenstrains to be applied in this strain calculation.");
 
  // Beam geometry
  params.addParam<RealGradient>("y_orientation",
                                "Orientation of the y direction along "
                                "which Iyy is provided. This should be "
                                "perpendicular to the axis of the beam.");
  params.addCoupledVar(
      "area",
      "Cross-section area of the beam. Can be supplied as either a number or a variable name.");
  params.addCoupledVar("Ay",
                       0.0,
                       "First moment of area of the beam about y axis. Can be supplied "
                       "as either a number or a variable name.");
  params.addCoupledVar("Az",
                       0.0,
                       "First moment of area of the beam about z axis. Can be supplied "
                       "as either a number or a variable name.");
  params.addCoupledVar("Ix",
                       "Second moment of area of the beam about x axis. Can be supplied as "
                       "either a number or a variable name.");
  params.addCoupledVar("Iy",
                       "Second moment of area of the beam about y axis. Can be supplied as "
                       "either a number or a variable name.");
  params.addCoupledVar("Iz",
                       "Second moment of area of the beam about z axis. Can be supplied as "
                       "either a number or a variable name.");
 
  // Common parameters for both dynamic consistent and nodal mass/inertia
  params.addParam<bool>("add_dynamic_variables",
                        "Adds translational and rotational velocity and acceleration aux variables "
                        "and sets up the corresponding AuxKernels for calculating these variables "
                        "using Newmark time integration. When dynamic_consistent_inertia, "
                        "dynamic_nodal_rotational_inertia or dynamic_nodal_translational_inertia "
                        "are set to true, these variables are automatically set up.");
 
  params.addParam<std::vector<VariableName>>("velocities", "Translational velocity variables");
  params.addParam<std::vector<VariableName>>("accelerations",
                                             "Translational acceleration variables");
  params.addParam<std::vector<VariableName>>("rotational_velocities",
                                             "Rotational velocity variables");
  params.addParam<std::vector<VariableName>>("rotational_accelerations",
                                             "Rotational acceleration variables");
  params.addRangeCheckedParam<Real>(
      "beta", "beta>0.0", "beta parameter for Newmark Time integration");
  params.addRangeCheckedParam<Real>(
      "gamma", "gamma>0.0", "gamma parameter for Newmark Time integration");
  params.addParam<MaterialPropertyName>("eta",
                                        0.0,
                                        "Name of material property or a constant real "
                                        "number defining the eta parameter for mass proportional "
                                        "Rayleigh damping.");
  params.addParam<MaterialPropertyName>(
      "zeta",
      0.0,
      "Name of material property or a constant real "
      "number defining the zeta parameter for stiffness proportional "
      "Rayleigh damping.");
  params.addRangeCheckedParam<Real>("alpha",
                                    0,
                                    "alpha>=-0.3333 & alpha<=0.0",
                                    "alpha parameter for mass dependent numerical damping induced "
                                    "by HHT time integration scheme");
 
  // dynamic consistent mass/inertia
  params.addParam<bool>("dynamic_consistent_inertia",
                        false,
                        "If set to true, consistent mass and "
                        "inertia matrices are used for the "
                        "inertial force/torque calculations.");
  params.addParam<MaterialPropertyName>(
      "density",
      "Name of Material Property or a constant real number defining the density of the beam.");
 
  // dynamic nodal translational inertia
  params.addParam<bool>(
      "dynamic_nodal_translational_inertia",
      false,
      "If set to true, nodal mass matrix is used for the inertial force calculation.");
  params.addRangeCheckedParam<Real>(
      "nodal_mass", "nodal_mass>0.0", "Mass associated with the node");
  params.addParam<FileName>(
      "nodal_mass_file",
      "The file containing the nodal positions and the corresponding nodal masses.");
 
  // dynamic nodal rotational inertia
  params.addParam<bool>(
      "dynamic_nodal_rotational_inertia",
      false,
      "If set to true, nodal inertia matrix is used for the inertial torque calculation.");
  params.addRangeCheckedParam<Real>(
      "nodal_Ixx", "nodal_Ixx>=0.0", "Nodal moment of inertia in the x direction.");
  params.addRangeCheckedParam<Real>(
      "nodal_Iyy", "nodal_Iyy>=0.0", "Nodal moment of inertia in the y direction.");
  params.addRangeCheckedParam<Real>(
      "nodal_Izz", "nodal_Izz>=0.0", "Nodal moment of inertia in the z direction.");
  params.addParam<Real>("nodal_Ixy", 0.0, "Nodal moment of inertia in the xy direction.");
  params.addParam<Real>("nodal_Ixz", 0.0, "Nodal moment of inertia in the xz direction.");
  params.addParam<Real>("nodal_Iyz", 0.0, "Nodal moment of inertia in the yz direction.");
  params.addParam<RealGradient>(
      "nodal_x_orientation",
      "Unit vector along the x direction if different from global x direction.");
  params.addParam<RealGradient>(
      "nodal_y_orientation",
      "Unit vector along the y direction if different from global y direction.");
  params.addParam<std::vector<BoundaryName>>(
      "boundary",
      {},
      "The list of boundary IDs from the mesh where the nodal "
      "mass/inertia will be applied.");
  return params;
}

Referenced by validParams().

◆ validParams()

InputParameters LineElementAction::validParams ( )

static

Definition at line 32 of file LineElementAction.C.

{
  InputParameters params = Action::validParams();
  params.addClassDescription("Sets up variables, stress divergence kernels and materials required "
                             "for a static analysis with beam or truss elements. Also sets up aux "
                             "variables, aux kernels, and consistent or nodal inertia kernels for "
                             "dynamic analysis with beam elements.");
 
  params.addParam<bool>(
      "truss",
      false,
      "Set to true if the line elements are truss elements instead of the default beam elements.");
  params.addParam<bool>("add_variables",
                        false,
                        "Add the displacement variables for truss elements "
                        "and both displacement and rotation variables for "
                        "beam elements.");
  params.addParam<std::vector<VariableName>>(
      "displacements", "The nonlinear displacement variables for the problem");
 
  // Common geometry parameters between beam and truss
  params.addCoupledVar(
      "area",
      "Cross-section area of the beam. Can be supplied as either a number or a variable name.");
 
  // Beam Parameters
  params += LineElementAction::beamParameters();
 
  params.addParam<bool>(
      "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
  // parameters specified here only appear in the input file sub-blocks of the
  // Master action, not in the common parameters area
  params.addParam<std::vector<SubdomainName>>(
      "block",
      {},
      "The list of ids of the blocks (subdomain) "
      "that the stress divergence, inertia kernels and materials will be "
      "applied to");
  // Advanced
  params.addParam<std::vector<AuxVariableName>>(
      "save_in", {}, "The displacement and rotational residuals");
  params.addParam<std::vector<AuxVariableName>>(
      "diag_save_in", {}, "The displacement and rotational diagonal preconditioner terms");
  params.addParamNamesToGroup("block", "Advanced");
  return params;
}

Referenced by CommonLineElementAction::validParams().

Member Data Documentation

◆ _accelerations

std::vector<VariableName> LineElementAction::_accelerations

protected

Names of translational acceleration variables for dynamic simulation beam element.

Definition at line 82 of file LineElementAction.h.

Referenced by actAddAuxKernels(), actAddAuxVariables(), actAddNodalKernels(), and LineElementAction().

◆ _add_dynamic_variables

bool LineElementAction::_add_dynamic_variables

protected

Set to true to set up translational and acceleration AuxVariables and the corresponding AuxKernels using the action when the dynamic kernels or nodal kernels are not set by the action.

Definition at line 133 of file LineElementAction.h.

Referenced by actAddAuxKernels(), actAddAuxVariables(), and LineElementAction().

◆ _diag_save_in

std::vector<AuxVariableName> LineElementAction::_diag_save_in

protected

Definition at line 98 of file LineElementAction.h.

Referenced by actAddKernels(), actAddNodalKernels(), and LineElementAction().

◆ _displacements

std::vector<VariableName> LineElementAction::_displacements

protected

Names of displacement variables.

Definition at line 64 of file LineElementAction.h.

Referenced by actAddAuxKernels(), actAddKernels(), actAddNodalKernels(), actAddVariables(), and LineElementAction().

◆ _dynamic_consistent_inertia

bool LineElementAction::_dynamic_consistent_inertia

protected

Set to true to use consistent mass and inertia matrices to calculate inertial forces/torques in dynamic beam simulations.

Definition at line 139 of file LineElementAction.h.

Referenced by actAddKernels(), and LineElementAction().

◆ _dynamic_nodal_rotational_inertia

bool LineElementAction::_dynamic_nodal_rotational_inertia

protected

Set to true to use nodal inertia matrix to calculate inertial torques in dynamic beam simulations.

Definition at line 151 of file LineElementAction.h.

Referenced by actAddNodalKernels(), and LineElementAction().

◆ _dynamic_nodal_translational_inertia

bool LineElementAction::_dynamic_nodal_translational_inertia

protected

Set to true to use nodal mass matrix to calculate inertial forces in dynamic beam simulations.

Definition at line 145 of file LineElementAction.h.

Referenced by actAddNodalKernels(), and LineElementAction().

◆ _ndisp

unsigned int LineElementAction::_ndisp

protected

Number of displacement variables.

Definition at line 67 of file LineElementAction.h.

Referenced by actAddAuxKernels(), actAddKernels(), actAddNodalKernels(), and LineElementAction().

◆ _rot_accelerations

std::vector<VariableName> LineElementAction::_rot_accelerations

protected

Names of rotational acceleration variables for dynamic simulation beam element.

Definition at line 94 of file LineElementAction.h.

Referenced by actAddAuxKernels(), actAddAuxVariables(), and LineElementAction().

◆ _rot_velocities

std::vector<VariableName> LineElementAction::_rot_velocities

protected

Names of rotational velocity variables for dynamic simulation using beam element.

Definition at line 88 of file LineElementAction.h.

Referenced by actAddAuxKernels(), actAddAuxVariables(), and LineElementAction().

◆ _rotation_type

Strain LineElementAction::_rotation_type

protected

Definition at line 123 of file LineElementAction.h.

Referenced by actAddMaterials(), and LineElementAction().

◆ _rotations

std::vector<VariableName> LineElementAction::_rotations

protected

Names of rotational variables for beam element.

Definition at line 70 of file LineElementAction.h.

Referenced by actAddAuxKernels(), actAddKernels(), actAddNodalKernels(), actAddVariables(), and LineElementAction().

◆ _save_in

std::vector<AuxVariableName> LineElementAction::_save_in

protected

residual debugging

Definition at line 97 of file LineElementAction.h.

Referenced by actAddKernels(), actAddNodalKernels(), and LineElementAction().

◆ _strain_type

enum LineElementAction::Strain LineElementAction::_strain_type

protected

Referenced by actAddMaterials(), and LineElementAction().

◆ _subdomain_id_union

std::set<SubdomainID> LineElementAction::_subdomain_id_union

protected

set generated from the combined block restrictions of all LineElementAction action blocks

Definition at line 114 of file LineElementAction.h.

Referenced by actGatherActionParameters().

◆ _subdomain_ids

std::set<SubdomainID> LineElementAction::_subdomain_ids

protected

set generated from the passed in vector of subdomain names

Definition at line 108 of file LineElementAction.h.

Referenced by act(), and actGatherActionParameters().

◆ _subdomain_names

std::vector<SubdomainName> LineElementAction::_subdomain_names

protected

If this vector is not empty the variables, auxvariables, kernels, auxkernels, nodalkernels and materials are restricted to these subdomains.

Definition at line 105 of file LineElementAction.h.

Referenced by act().

◆ _truss

bool LineElementAction::_truss

protected

Set to true if line element is a truss.

Definition at line 154 of file LineElementAction.h.

Referenced by actAddAuxKernels(), actAddAuxVariables(), actAddKernels(), actAddMaterials(), actAddNodalKernels(), actAddVariables(), and LineElementAction().

◆ _use_displaced_mesh

bool LineElementAction::_use_displaced_mesh

protected

use displaced mesh (true unless _strain is SMALL_STRAIN_AND_ROTATION)

Definition at line 126 of file LineElementAction.h.

Referenced by actAddKernels(), actAddNodalKernels(), and LineElementAction().

◆ _velocities

std::vector<VariableName> LineElementAction::_velocities

protected

Names of translational velocity variables for dynamic simulation using beam element.

Definition at line 76 of file LineElementAction.h.

Referenced by actAddAuxKernels(), actAddAuxVariables(), actAddNodalKernels(), and LineElementAction().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Strain

Constructor & Destructor Documentation

◆ LineElementAction()

Member Function Documentation

◆ act()

◆ actAddAuxKernels()

◆ actAddAuxVariables()

◆ actAddKernels()

◆ actAddMaterials()

◆ actAddNodalKernels()

◆ actAddVariables()

◆ actGatherActionParameters()

◆ beamParameters()

◆ validParams()

Member Data Documentation

◆ _accelerations

◆ _add_dynamic_variables

◆ _diag_save_in

◆ _displacements

◆ _dynamic_consistent_inertia

◆ _dynamic_nodal_rotational_inertia

◆ _dynamic_nodal_translational_inertia

◆ _ndisp

◆ _rot_accelerations

◆ _rot_velocities

◆ _rotation_type

◆ _rotations

◆ _save_in

◆ _strain_type

◆ _subdomain_id_union

◆ _subdomain_ids

◆ _subdomain_names

◆ _truss

◆ _use_displaced_mesh

◆ _velocities