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

#include <MechanicsActionPD.h>

Inheritance diagram for MechanicsActionPD:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	MechanicsActionPD (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

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 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 Member Functions
virtual std::string	getKernelName ()
	Function to get the kernel name based on the value of member variables: _formulation and _stabilization.

virtual InputParameters	getKernelParameters (std::string name)
	Function to get the input parameters for a given kernel name.

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
const MooseEnum	_formulation
	Option of which peridynamic model needs to be setup: BOND, ORDINARY_STATE or NONORDINARY_STATE.

const MooseEnum	_stabilization
	Option of stabilization scheme for correspondence material model: FORCE, BOND_HORIZON_I or BOND_HORIZON_II.

const MooseEnum	_strain
	Option of strain formulation: SMALL or FINITE.

std::vector< SubdomainName >	_subdomain_names
	vector of subdomain names from provided blocks

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

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

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< VariableName >	_displacements
	Displacement variables.

const unsigned int	_ndisp


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

Action class to setup peridynamic models for solid mechanics problems.

Definition at line 17 of file MechanicsActionPD.h.

Constructor & Destructor Documentation

◆ MechanicsActionPD()

MechanicsActionPD::MechanicsActionPD ( const InputParameters & params )

Definition at line 65 of file MechanicsActionPD.C.

  : Action(params),
    _displacements(getParam<std::vector<VariableName>>("displacements")),
    _ndisp(_displacements.size()),
    _formulation(getParam<MooseEnum>("formulation")),
    _stabilization(getParam<MooseEnum>("stabilization")),
    _strain(getParam<MooseEnum>("strain")),
    _subdomain_names(getParam<std::vector<SubdomainName>>("block")),
    _subdomain_ids(),
    _save_in(getParam<std::vector<AuxVariableName>>("save_in")),
    _diag_save_in(getParam<std::vector<AuxVariableName>>("diag_save_in"))
{
  // Consistency check
  if (_formulation == "NONORDINARY_STATE" && !isParamValid("stabilization"))
    mooseError("'stabilization' is a required parameter for non-ordinary state-based models only.");
 
  if (_save_in.size() != 0 && _save_in.size() != _ndisp)
    mooseError("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)
    mooseError(
        "Number of diag_save_in variables should equal to the number of displacement variables ",
        _ndisp);
}

Member Function Documentation

◆ act()

void MechanicsActionPD::act ( )

overridevirtual

Implements Action.

Definition at line 92 of file MechanicsActionPD.C.

{
  if (_current_task == "setup_mesh_complete")
  {
    // get subdomain IDs
    for (auto & name : _subdomain_names)
      _subdomain_ids.insert(_mesh->getSubdomainID(name));
  }
  else if (_current_task == "create_problem_complete")
  {
    // Gather info about all other master actions for adding (aux)variables
    auto actions = _awh.getActions<MechanicsActionPD>();
    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)
        mooseError("The block restrictions in the Peridynamics/Mechanics/Master actions must be "
                   "non-overlapping!");
 
      if (added_size == 0 && actions.size() > 1)
        mooseError(
            "No Peridynamics/Mechanics/Master action can be block unrestricted if more than one "
            "Peridynamics/Mechanics/Master action is specified!");
    }
  }
  else if (_current_task == "add_aux_variable")
  {
    // add the bond_status aux variable to all peridynamic domains
    const std::string var_type = "MooseVariableConstMonomial";
    InputParameters params = _factory.getValidParams(var_type);
    params.set<MooseEnum>("order") = "CONSTANT";
    params.set<MooseEnum>("family") = "MONOMIAL";
 
    if (!_subdomain_id_union.empty())
      for (const SubdomainID & id : _subdomain_id_union)
        params.set<std::vector<SubdomainName>>("block").push_back(Moose::stringify(id));
 
    _problem->addAuxVariable(var_type, "bond_status", params);
  }
  else if (_current_task == "add_ic")
  {
    const std::string ic_type = "ConstantIC";
    const std::string ic_name = name() + "bond_status";
 
    InputParameters params = _factory.getValidParams(ic_type);
    params.set<VariableName>("variable") = "bond_status";
    params.set<Real>("value") = 1.0;
 
    // check whether this object is restricted to certain block?
    if (isParamValid("block"))
      params.set<std::vector<SubdomainName>>("block") = _subdomain_names;
 
    _problem->addInitialCondition(ic_type, ic_name, params);
  }
  else if (_current_task == "add_user_object")
  {
    // add ghosting UO
    const std::string uo_type = "GhostElemPD";
    const std::string uo_name = name() + "GhostElemPD";
 
    InputParameters params = _factory.getValidParams(uo_type);
    params.set<bool>("use_displaced_mesh") = (_strain == "FINITE");
 
    _problem->addUserObject(uo_type, uo_name, params);
  }
  else if (_current_task == "add_kernel")
  {
    const std::string kernel_name = getKernelName();
    InputParameters params = getKernelParameters(kernel_name);
 
    for (unsigned int i = 0; i < _ndisp; ++i)
    {
      const std::string kernel_object_name = name() + "Peridynamics_" + Moose::stringify(i);
 
      params.set<unsigned int>("component") = i;
      params.set<NonlinearVariableName>("variable") = _displacements[i];
 
      if (_save_in.size() != 0)
        params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
      if (_diag_save_in.size() != 0)
        params.set<std::vector<AuxVariableName>>("diag_save_in") = {_diag_save_in[i]};
 
      _problem->addKernel(kernel_name, kernel_object_name, params);
    }
  }
  else
    mooseError("Task error in MechanicsActionPD!");
}

◆ 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.

{
  std::string name;
 
  if (_formulation == "BOND")
  {
    name = "MechanicsBPD";
  }
  else if (_formulation == "ORDINARY_STATE")
  {
    name = "MechanicsOSPD";
  }
  else if (_formulation == "NONORDINARY_STATE")
  {
    if (_stabilization == "FORCE")
    {
      name = "ForceStabilizedSmallStrainMechanicsNOSPD";
    }
    else if (_stabilization == "BOND_HORIZON_I")
    {
      if (_strain == "SMALL")
        name = "HorizonStabilizedFormISmallStrainMechanicsNOSPD";
      else
        name = "HorizonStabilizedFormIFiniteStrainMechanicsNOSPD";
    }
    else if (_stabilization == "BOND_HORIZON_II")
    {
      if (_strain == "SMALL")
        name = "HorizonStabilizedFormIISmallStrainMechanicsNOSPD";
      else
        name = "HorizonStabilizedFormIIFiniteStrainMechanicsNOSPD";
    }
    else
      paramError("stabilization", "Unknown PD stabilization scheme!");
  }
  else
    paramError("formulation", "Unsupported peridynamic formulation!");
 
  return name;
}

Referenced by act().

◆ getKernelParameters()

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

protectedvirtual

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

Parameters

name	the name of the kernel

Returns: Parameters for the corresponding kernel

Definition at line 228 of file MechanicsActionPD.C.

{
  InputParameters params = _factory.getValidParams(name);
 
  params.applyParameters(parameters(),
                         {"displacements",
                          "temperature",
                          "out_of_plane_strain",
                          "eigenstrain_names",
                          "use_displaced_mesh",
                          "save_in",
                          "diag_save_in"});
 
  params.set<std::vector<VariableName>>("displacements") = _displacements;
  if (isParamValid("temperature"))
    params.set<std::vector<VariableName>>("temperature") = {getParam<VariableName>("temperature")};
  if (isParamValid("out_of_plane_strain"))
    params.set<std::vector<VariableName>>("out_of_plane_strain") = {
        getParam<VariableName>("out_of_plane_strain")};
 
  // peridynamics modules are formulated based on initial configuration
  params.set<bool>("use_displaced_mesh") = false;
 
  if (_formulation == "NONORDINARY_STATE" && isParamValid("eigenstrain_names"))
  {
    params.set<std::vector<MaterialPropertyName>>("eigenstrain_names") =
        getParam<std::vector<MaterialPropertyName>>("eigenstrain_names");
  }
 
  return params;
}

Referenced by act().

◆ validParams()

InputParameters MechanicsActionPD::validParams ( )

static

Definition at line 26 of file MechanicsActionPD.C.

{
  InputParameters params = Action::validParams();
  params.addClassDescription("Class for setting up peridynamic kernels");
 
  params.addRequiredParam<std::vector<VariableName>>(
      "displacements", "Nonlinear variable names for the displacements");
  MooseEnum formulation_option("BOND ORDINARY_STATE NONORDINARY_STATE");
  params.addRequiredParam<MooseEnum>(
      "formulation", formulation_option, "Peridynamic formulation options");
  MooseEnum stabilization_option("FORCE BOND_HORIZON_I BOND_HORIZON_II");
  params.addParam<MooseEnum>("stabilization",
                             stabilization_option,
                             "Stabilization techniques for the peridynamic correspondence model");
  params.addParam<bool>(
      "full_jacobian",
      false,
      "Parameter to set whether to use full jacobian for state based formulation or not");
  MooseEnum strain_type("SMALL FINITE", "SMALL");
  params.addParam<MooseEnum>("strain", strain_type, "Strain formulation");
  params.addParam<VariableName>("temperature", "Nonlinear variable name for the temperature");
  params.addParam<VariableName>("out_of_plane_strain",
                                "Nonlinear variable name for the out_of_plane strain for "
                                "plane stress using the NOSPD formulation");
  params.addParam<std::vector<SubdomainName>>("block",
                                              {},
                                              "List of ids of the blocks (subdomains) that the "
                                              "peridynamic mechanics kernel will be applied to");
  params.addParam<std::vector<AuxVariableName>>("save_in", {}, "The displacement residuals");
  params.addParam<std::vector<AuxVariableName>>(
      "diag_save_in", {}, "The displacement diagonal preconditioner terms");
  params.addParam<std::vector<MaterialPropertyName>>(
      "eigenstrain_names",
      {},
      "List of eigenstrains to be coupled in non-ordinary state-based mechanics kernels");
 
  return params;
}

Member Data Documentation

◆ _diag_save_in

std::vector<AuxVariableName> MechanicsActionPD::_diag_save_in

protected

Definition at line 69 of file MechanicsActionPD.h.

Referenced by act(), and MechanicsActionPD().

◆ _displacements

std::vector<VariableName> MechanicsActionPD::_displacements

protected

Displacement variables.

Definition at line 42 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 48 of file MechanicsActionPD.h.

Referenced by getKernelName(), getKernelParameters(), and MechanicsActionPD().

◆ _ndisp

const unsigned int MechanicsActionPD::_ndisp

protected

Definition at line 43 of file MechanicsActionPD.h.

Referenced by act(), and MechanicsActionPD().

◆ _save_in

std::vector<AuxVariableName> MechanicsActionPD::_save_in

protected

Residual debugging.

Definition at line 68 of file MechanicsActionPD.h.

Referenced by act(), and MechanicsActionPD().

◆ _stabilization

const MooseEnum MechanicsActionPD::_stabilization

protected

Option of stabilization scheme for correspondence material model: FORCE, BOND_HORIZON_I or BOND_HORIZON_II.

Definition at line 52 of file MechanicsActionPD.h.

Referenced by getKernelName().

◆ _strain

const MooseEnum MechanicsActionPD::_strain

protected

Option of strain formulation: SMALL or FINITE.

Definition at line 55 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 65 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 61 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 58 of file MechanicsActionPD.h.

Referenced by act().

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

peridynamics/include/actions/MechanicsActionPD.h
peridynamics/src/actions/MechanicsActionPD.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MechanicsActionPD()

Member Function Documentation

◆ act()

◆ getKernelName()

◆ getKernelParameters()

◆ validParams()

Member Data Documentation

◆ _diag_save_in

◆ _displacements

◆ _formulation

◆ _ndisp

◆ _save_in

◆ _stabilization

◆ _strain

◆ _subdomain_id_union

◆ _subdomain_ids

◆ _subdomain_names