#include <CohesiveZoneAction.h>

Inheritance diagram for CohesiveZoneAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	CohesiveZoneAction (const InputParameters &params)

virtual void	addRelationshipManagers (Moose::RelationshipManagerType input_rm_type) override

void	act () override

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)
	Method adding the proper relationship manager.

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
	Method adding the proper relationship manager.

void	timedAct ()

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)


static MultiMooseEnum	outputPropertiesType ()
	output methods

static MultiMooseEnum	materialOutputOrders ()

static MultiMooseEnum	materialOutputFamilies ()

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


static const std::map< std::string, std::string >	_real_vector_cartesian_component_table
	table data for output generation

static const std::map< std::string, std::pair< std::string, std::vector< std::string > > >	_vector_direction_table

static const std::vector< char >	_component_table = {'x', 'y', 'z'}

Protected Types
enum class	Strain { Small , Finite }
	strain formulation More...

Protected Member Functions
void	actOutputGeneration ()

void	actOutputMatProp ()

void	addRequiredCZMInterfaceKernels ()
	adds the required interfacekernels based on the selected strain formulation

void	addRequiredCZMInterfaceMaterials ()
	adds the required interface materials based on the selected strain formulation

void	verifyOrderAndFamilyOutputs ()
	verifies order and family of output variables

void	prepareSaveInInputs (std::vector< AuxVariableName > &, std::string &, const std::vector< AuxVariableName > &, const std::vector< AuxVariableName > &, const int &) const
	method to prepare save_in and diag_save_in inputs for the interface kernel

void	chekMultipleActionParameters ()
	method checking multiple CohesiveZoneAction block inputs

template<typename T , typename T2 >
bool	setupOutput (std::string out, T table, T2 setup)

std::string	addBaseName (const std::string &name) const
	simple method for adding the base name to a variable

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
	the disaplcements varaible names

const unsigned int	_ndisp
	number of displacement components

const bool	_use_AD
	whether to use AD kernels and materials

const std::string	_base_name
	Base name of the material system.

const std::vector< BoundaryName >	_boundary
	Base name of the material system.

enum CohesiveZoneAction::Strain	_strain

std::vector< std::string >	_generate_output
	output materials to generate scalar traction/jump vector quantities

MultiMooseEnum	_material_output_order

MultiMooseEnum	_material_output_family

std::set< BoundaryName >	_boundary_name_union
	set generated from the combined boundary restrictions of all CohesiveZoneAction action blocks

std::set< Strain >	_strain_formulation_union
	set generated from the combined boundary restrictions of all CohesiveZoneAction action blocks

const bool	_verbose
	display info

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_primary
	residual debugging

std::vector< AuxVariableName >	_diag_save_in_primary

std::vector< AuxVariableName >	_save_in_secondary

std::vector< AuxVariableName >	_diag_save_in_secondary


std::string	_czm_kernel_name
	kernel's and materials's names

std::string	_disp_jump_provider_name

std::string	_equilibrium_traction_calculator_name

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

Member Enumeration Documentation

◆ Strain

enum class CohesiveZoneAction::Strain

strongprotected

strain formulation

Enumerator
Small
Finite

Definition at line 68 of file CohesiveZoneAction.h.

  {
    Small,
    Finite
  } _strain;

Constructor & Destructor Documentation

◆ CohesiveZoneAction()

CohesiveZoneAction::CohesiveZoneAction ( const InputParameters & params )

Definition at line 35 of file CohesiveZoneAction.C.

  : CohesiveZoneActionBase(params),
    _displacements(getParam<std::vector<VariableName>>("displacements")),
    _ndisp(_displacements.size()),
    _use_AD(getParam<bool>("use_automatic_differentiation")),
    _base_name(isParamValid("base_name") && !getParam<std::string>("base_name").empty()
                   ? getParam<std::string>("base_name")
                   : ""),
    _boundary(getParam<std::vector<BoundaryName>>("boundary")),
    _strain(getParam<MooseEnum>("strain").getEnum<Strain>()),
    _save_in_primary(getParam<std::vector<AuxVariableName>>("save_in_primary")),
    _diag_save_in_primary(getParam<std::vector<AuxVariableName>>("diag_save_in_primary")),
    _save_in_secondary(getParam<std::vector<AuxVariableName>>("save_in_secondary")),
    _diag_save_in_secondary(getParam<std::vector<AuxVariableName>>("diag_save_in_secondary")),
    _material_output_order(getParam<MultiMooseEnum>("material_output_order")),
    _material_output_family(getParam<MultiMooseEnum>("material_output_family")),
    _verbose(getParam<bool>("verbose"))
{
  // We can't enforce consistency between the number of displacement variables and the mesh
  // dimension. Hence we only check we have a reasonable number of displacement variables
  if (_ndisp > 3 || _ndisp < 1)
    mooseError("the CZM Action requires 1, 2 or 3 displacement variables.");
 
  switch (_strain)
  {
    case Strain::Small:
    {
      _czm_kernel_name =
          _use_AD ? "ADCZMInterfaceKernelSmallStrain" : "CZMInterfaceKernelSmallStrain";
      _disp_jump_provider_name = _use_AD ? "ADCZMComputeDisplacementJumpSmallStrain"
                                         : "CZMComputeDisplacementJumpSmallStrain";
      _equilibrium_traction_calculator_name =
          _use_AD ? "ADCZMComputeGlobalTractionSmallStrain" : "CZMComputeGlobalTractionSmallStrain";
      break;
    }
    case Strain::Finite:
    {
      _czm_kernel_name =
          _use_AD ? "ADCZMInterfaceKernelTotalLagrangian" : "CZMInterfaceKernelTotalLagrangian";
      _disp_jump_provider_name = _use_AD ? "ADCZMComputeDisplacementJumpTotalLagrangian"
                                         : "CZMComputeDisplacementJumpTotalLagrangian";
      _equilibrium_traction_calculator_name = _use_AD ? "ADCZMComputeGlobalTractionTotalLagrangian"
                                                      : "CZMComputeGlobalTractionTotalLagrangian";
      break;
    }
    default:
      mooseError("CohesiveZoneAction Error: Invalid kinematic parameter. Allowed values are: "
                 "SmallStrain or TotalLagrangian");
  }
 
  if (_save_in_primary.size() != 0 && _save_in_primary.size() != _ndisp)
    mooseError(
        "Number of save_in_primary variables should equal to the number of displacement variables ",
        _ndisp);
  if (_diag_save_in_primary.size() != 0 && _diag_save_in_primary.size() != _ndisp)
    mooseError(
        "Number of diag_save_in_primary variables should equal to the number of displacement "
        "variables ",
        _ndisp);
  if (_save_in_secondary.size() != 0 && _save_in_secondary.size() != _ndisp)
    mooseError("Number of save_in_secondary variables should equal to the number of displacement "
               "variables ",
               _ndisp);
 
  if (_diag_save_in_secondary.size() != 0 && _diag_save_in_secondary.size() != _ndisp)
    mooseError(
        "Number of diag_save_in_secondary variables should equal to the number of displacement "
        "variables ",
        _ndisp);
 
  // convert output variable names to lower case
  for (const auto & out : getParam<MultiMooseEnum>("generate_output"))
  {
    std::string lower(out);
    std::transform(lower.begin(), lower.end(), lower.begin(), ::tolower);
    _generate_output.push_back(lower);
  }
 
  if (!_generate_output.empty())
    verifyOrderAndFamilyOutputs();
}

Member Function Documentation

◆ act()

void CohesiveZoneAction::act ( )

overridevirtual

Implements Action.

Definition at line 176 of file CohesiveZoneAction.C.

{
  // Enforce consistency
  if (_ndisp != _mesh->dimension())
    paramError("displacements", "Number of displacements must match problem dimension.");
 
  chekMultipleActionParameters();
 
  if (_current_task == "add_interface_kernel")
    addRequiredCZMInterfaceKernels();
  else if (_current_task == "add_master_action_material")
    addRequiredCZMInterfaceMaterials();
 
  // optional, add required outputs
  actOutputGeneration();
}

◆ actOutputGeneration()

void CohesiveZoneAction::actOutputGeneration ( )

protected

Definition at line 274 of file CohesiveZoneAction.C.

{
  if (_current_task == "add_material")
    actOutputMatProp();
 
  // Add variables (optional)
  if (_current_task == "add_aux_variable")
  {
    unsigned int index = 0;
    for (auto out : _generate_output)
    {
      const auto & order = _material_output_order[index];
      const auto & family = _material_output_family[index];
 
      std::string type = (order == "CONSTANT" && family == "MONOMIAL")
                             ? "MooseVariableConstMonomial"
                             : "MooseVariable";
 
      // Create output helper aux variables
      auto params = _factory.getValidParams(type);
      params.set<MooseEnum>("order") = order;
      params.set<MooseEnum>("family") = family;
      if (family == "MONOMIAL")
        _problem->addAuxVariable(type, addBaseName(out), params);
      else
        _problem->addVariable(type, addBaseName(out), params);
 
      index++;
    }
  }
 
  // Add output AuxKernels
  else if (_current_task == "add_aux_kernel")
  {
    const std::string material_output_aux_name = _use_AD ? "ADMaterialRealAux" : "MaterialRealAux";
    // Loop through output aux variables
    unsigned int index = 0;
    for (auto out : _generate_output)
    {
      if (_material_output_family[index] == "MONOMIAL")
      {
        InputParameters params = _factory.getValidParams(material_output_aux_name);
        params.set<MaterialPropertyName>("property") = addBaseName(out);
        params.set<AuxVariableName>("variable") = addBaseName(out);
        params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
        params.set<std::vector<BoundaryName>>("boundary") = _boundary;
        params.set<bool>("check_boundary_restricted") = false;
        _problem->addAuxKernel(material_output_aux_name, addBaseName(out) + '_' + name(), params);
      }
      index++;
    }
  }
}

Referenced by act().

◆ actOutputMatProp()

void CohesiveZoneAction::actOutputMatProp ( )

protected

Definition at line 329 of file CohesiveZoneAction.C.

{
  if (_current_task == "add_material")
  {
    // Add output Materials
    for (auto out : _generate_output)
    {
      InputParameters params = emptyInputParameters();
 
      // RealVectorCartesianComponent
      if (
          [&]()
          {
            for (const auto & vq : _real_vector_cartesian_component_table)
              for (unsigned int a = 0; a < 3; ++a)
                if (vq.first + '_' + _component_table[a] == out)
                {
                  auto type = _use_AD ? "ADCZMRealVectorCartesianComponent"
                                      : "CZMRealVectorCartesianComponent";
                  params = _factory.getValidParams(type);
                  params.set<std::string>("real_vector_value") = vq.second;
                  params.set<unsigned int>("index") = a;
                  params.set<std::vector<BoundaryName>>("boundary") = _boundary;
                  params.set<MaterialPropertyName>("property_name") = addBaseName(out);
                  params.set<std::string>("base_name") = _base_name;
                  _problem->addInterfaceMaterial(type, addBaseName(out) + '_' + name(), params);
                  return true;
                }
            return false;
          }())
        continue;
 
      // CZMRealVectorScalar
      if (setupOutput(out,
                      _vector_direction_table,
                      [&](std::string prop_name, std::string direction)
                      {
                        auto type = _use_AD ? "ADCZMRealVectorScalar" : "CZMRealVectorScalar";
                        params = _factory.getValidParams(type);
                        params.set<std::string>("real_vector_value") = prop_name;
                        params.set<MooseEnum>("direction") = direction;
                        params.set<MaterialPropertyName>("property_name") = addBaseName(out);
                        params.set<std::vector<BoundaryName>>("boundary") = _boundary;
                        params.set<std::string>("base_name") = _base_name;
                        _problem->addInterfaceMaterial(
                            type, addBaseName(out) + '_' + name(), params);
                      }))
        continue;
 
      mooseError("CZM Master: unable to add output Material");
    }
  }
}

Referenced by actOutputGeneration().

◆ addBaseName()

std::string CohesiveZoneAction::addBaseName ( const std::string & name ) const

inlineprotected

simple method for adding the base name to a variable

Definition at line 103 of file CohesiveZoneAction.h.

  {
    return _base_name.empty() ? name : _base_name + "_" + name;
  }

Referenced by actOutputGeneration(), and actOutputMatProp().

◆ addRelationshipManagers() [1/3]

void CohesiveZoneAction::addRelationshipManagers ( Moose::RelationshipManagerType input_rm_type )

overridevirtual

Reimplemented from Action.

Definition at line 194 of file CohesiveZoneAction.C.

{
  InputParameters ips = _factory.getValidParams(_czm_kernel_name);
  addRelationshipManagers(input_rm_type, ips);
}

Referenced by addRelationshipManagers().

◆ addRelationshipManagers() [2/3]

virtual void Action::addRelationshipManagers ( Moose::RelationshipManagerType when_type )

virtual

Method adding the proper relationship manager.

Reimplemented from Action.

◆ addRelationshipManagers() [3/3]

bool Action::addRelationshipManagers	(	Moose::RelationshipManagerType	when_type,
		const InputParameters &	moose_object_pars
	)

Method adding the proper relationship manager.

◆ addRequiredCZMInterfaceKernels()

void CohesiveZoneAction::addRequiredCZMInterfaceKernels ( )

protected

adds the required interfacekernels based on the selected strain formulation

Definition at line 118 of file CohesiveZoneAction.C.

{
  for (unsigned int i = 0; i < _ndisp; ++i)
  {
    // Create unique kernel name for each displacement component
    std::string unique_kernel_name = _czm_kernel_name + "_" + _name + "_" + Moose::stringify(i);
 
    InputParameters paramsk = _factory.getValidParams(_czm_kernel_name);
 
    paramsk.set<unsigned int>("component") = i;
    paramsk.set<NonlinearVariableName>("variable") = _displacements[i];
    paramsk.set<std::vector<VariableName>>("neighbor_var") = {_displacements[i]};
    paramsk.set<std::vector<VariableName>>("displacements") = _displacements;
    paramsk.set<std::vector<BoundaryName>>("boundary") = _boundary;
    paramsk.set<std::string>("base_name") = _base_name;
 
    std::string save_in_side;
    std::vector<AuxVariableName> save_in_var_names;
    if (_save_in_primary.size() == _ndisp || _save_in_secondary.size() == _ndisp)
    {
      prepareSaveInInputs(save_in_var_names, save_in_side, _save_in_primary, _save_in_secondary, i);
      paramsk.set<std::vector<AuxVariableName>>("save_in") = save_in_var_names;
      paramsk.set<MultiMooseEnum>("save_in_var_side") = save_in_side;
    }
    if (_diag_save_in_primary.size() == _ndisp || _diag_save_in_secondary.size() == _ndisp)
    {
      prepareSaveInInputs(
          save_in_var_names, save_in_side, _diag_save_in_primary, _diag_save_in_secondary, i);
      paramsk.set<std::vector<AuxVariableName>>("diag_save_in") = save_in_var_names;
      paramsk.set<MultiMooseEnum>("diag_save_in_var_side") = save_in_side;
    }
    _problem->addInterfaceKernel(_czm_kernel_name, unique_kernel_name, paramsk);
  }
}

Referenced by act().

◆ addRequiredCZMInterfaceMaterials()

void CohesiveZoneAction::addRequiredCZMInterfaceMaterials ( )

protected

adds the required interface materials based on the selected strain formulation

Definition at line 154 of file CohesiveZoneAction.C.

{
  // Create unique material name for the "CZMComputeDisplacementJump" object
  std::string unique_material_name = _disp_jump_provider_name + "_" + _name;
  InputParameters paramsm = _factory.getValidParams(_disp_jump_provider_name);
  paramsm.set<std::vector<BoundaryName>>("boundary") = _boundary;
 
  paramsm.set<std::vector<VariableName>>("displacements") = _displacements;
  paramsm.set<std::string>("base_name") = _base_name;
  _problem->addInterfaceMaterial(_disp_jump_provider_name, unique_material_name, paramsm);
 
  // Create unique material name for the "CZMComputeGlobalTraction" object
  unique_material_name = _equilibrium_traction_calculator_name + "_" + _name;
  paramsm = _factory.getValidParams(_equilibrium_traction_calculator_name);
  paramsm.set<std::vector<BoundaryName>>("boundary") = _boundary;
 
  paramsm.set<std::string>("base_name") = _base_name;
  _problem->addInterfaceMaterial(
      _equilibrium_traction_calculator_name, unique_material_name, paramsm);
}

Referenced by act().

◆ chekMultipleActionParameters()

void CohesiveZoneAction::chekMultipleActionParameters ( )

protected

method checking multiple CohesiveZoneAction block inputs

Definition at line 384 of file CohesiveZoneAction.C.

{
 
  // Gather info about all other master actions when we add variables
  if (_current_task == "validate_coordinate_systems")
  {
    auto actions = _awh.getActions<CohesiveZoneAction>();
    for (const auto & action : actions)
    {
      const auto size_before = _boundary_name_union.size();
      const auto added_size = action->_boundary.size();
      _boundary_name_union.insert(action->_boundary.begin(), action->_boundary.end());
      const auto size_after = _boundary_name_union.size();
      if (size_after != size_before + added_size)
        mooseError("The boundary restrictions in the CohesiveZoneAction actions must be "
                   "non-overlapping.");
    }
 
    for (const auto & action : actions)
    {
      // check for different strain definitions
      _strain_formulation_union.insert(action->_strain);
      const auto size_after = _strain_formulation_union.size();
 
      if (size_after != 1)
        mooseError("All blocks of the CohesiveZoneAction should have the same strain formulation");
    }
  }
}

Referenced by act().

◆ materialOutputFamilies()

MultiMooseEnum CohesiveZoneActionBase::materialOutputFamilies ( )

staticinherited

Definition at line 164 of file CohesiveZoneActionBase.C.

{
  return MultiMooseEnum("MONOMIAL");
}

Referenced by CohesiveZoneActionBase::validParams().

◆ materialOutputOrders()

MultiMooseEnum CohesiveZoneActionBase::materialOutputOrders ( )

staticinherited

Definition at line 156 of file CohesiveZoneActionBase.C.

{
  auto orders = AddAuxVariableAction::getAuxVariableOrders().getRawNames();
 
  return MultiMooseEnum(orders);
}

Referenced by CohesiveZoneActionBase::validParams().

◆ outputPropertiesType()

MultiMooseEnum CohesiveZoneActionBase::outputPropertiesType ( )

staticinherited

output methods

Definition at line 141 of file CohesiveZoneActionBase.C.

{
  std::string options = "";
  for (auto & vc : _real_vector_cartesian_component_table)
    for (unsigned int a = 0; a < 3; ++a)
      options += (options == "" ? "" : " ") + vc.first + '_' + _component_table[a];
 
  for (auto & vi : _vector_direction_table)
    for (auto & t : vi.second.second)
      options += " " + vi.first + "_" + t;
 
  return MultiMooseEnum(options, "", true);
}

Referenced by CohesiveZoneActionBase::validParams().

◆ prepareSaveInInputs()

void CohesiveZoneAction::prepareSaveInInputs	(	std::vector< AuxVariableName > &	save_in_names,
		std::string &	save_in_side,
		const std::vector< AuxVariableName > &	var_name_primary,
		const std::vector< AuxVariableName > &	var_name_secondary,
		const int &	i
	)		const

protected

method to prepare save_in and diag_save_in inputs for the interface kernel

Definition at line 201 of file CohesiveZoneAction.C.

{
  save_in_names.clear();
  save_in_side.clear();
  if (var_name_primary.size() == _ndisp)
  {
    save_in_names.push_back(var_name_primary[i]);
    save_in_side += "m";
    if (var_name_secondary.size() == _ndisp)
      save_in_side += " ";
  }
  if (var_name_secondary.size() == _ndisp)
  {
    save_in_names.push_back(var_name_secondary[i]);
    save_in_side += "s";
  }
}

Referenced by addRequiredCZMInterfaceKernels().

◆ setupOutput()

template<typename T , typename T2 >

bool CohesiveZoneAction::setupOutput	(	std::string	out,
		T	table,
		T2	setup
	)

protected

Definition at line 111 of file CohesiveZoneAction.h.

{
  for (const auto & t1 : table)
  {
    // find the officially supported properties
    for (const auto & t2 : t1.second.second)
      if (t1.first + '_' + t2 == out)
      {
        const auto it = _real_vector_cartesian_component_table.find(t2);
        if (it != _real_vector_cartesian_component_table.end())
        {
          setup(it->second, t1.second.first);
          return true;
        }
        else
          mooseError("Internal error. The permitted vector shortcuts must be keys in the "
                     "'_real_vector_cartesian_component_table'.");
      }
 
    // check for custom properties
    auto prefix = t1.first + '_';
    if (out.substr(0, prefix.length()) == prefix)
    {
      setup(out.substr(prefix.length()), t1.second.first);
      return true;
    }
  }
 
  return false;
}

Referenced by actOutputMatProp().

◆ validParams()

InputParameters CohesiveZoneAction::validParams ( )

static

Definition at line 25 of file CohesiveZoneAction.C.

{
  InputParameters params = CohesiveZoneActionBase::validParams();
  params.addClassDescription("Action to create an instance of the cohesive zone model kernel for "
                             "each displacement component");
  params.addRequiredParam<std::vector<BoundaryName>>(
      "boundary", "The list of boundary IDs from the mesh where the cohesive zone will be applied");
  return params;
}

◆ verifyOrderAndFamilyOutputs()

void CohesiveZoneAction::verifyOrderAndFamilyOutputs ( )

protected

verifies order and family of output variables

Definition at line 224 of file CohesiveZoneAction.C.

{
  // Ensure material output order and family vectors are same size as generate output
 
  // check number of supplied orders and families
  if (_material_output_order.size() > 1 && _material_output_order.size() < _generate_output.size())
    paramError("material_output_order",
               "The number of orders assigned to material outputs must be: 0 to be assigned "
               "CONSTANT; 1 to assign all outputs the same value, or the same size as the number "
               "of generate outputs listed.");
 
  if (_material_output_family.size() > 1 &&
      _material_output_family.size() < _generate_output.size())
    paramError("material_output_family",
               "The number of families assigned to material outputs must be: 0 to be assigned "
               "MONOMIAL; 1 to assign all outputs the same value, or the same size as the number "
               "of generate outputs listed.");
 
  // if no value was provided, chose the default CONSTANT
  if (_material_output_order.size() == 0)
    _material_output_order.setAdditionalValue("CONSTANT");
 
  // For only one order, make all orders the same magnitude
  if (_material_output_order.size() == 1)
    _material_output_order =
        std::vector<std::string>(_generate_output.size(), _material_output_order[0]);
 
  if (_verbose)
    Moose::out << COLOR_CYAN << "*** Automatic applied material output orders ***"
               << "\n"
               << _name << ": " << Moose::stringify(_material_output_order) << "\n"
               << COLOR_DEFAULT;
 
  // if no value was provided, chose the default MONOMIAL
  if (_material_output_family.size() == 0)
    _material_output_family.setAdditionalValue("MONOMIAL");
 
  // For only one family, make all families that value
  if (_material_output_family.size() == 1)
    _material_output_family =
        std::vector<std::string>(_generate_output.size(), _material_output_family[0]);
 
  if (_verbose)
    Moose::out << COLOR_CYAN << "*** Automatic applied material output families ***"
               << "\n"
               << _name << ": " << Moose::stringify(_material_output_family) << "\n"
               << COLOR_DEFAULT;
}

Referenced by CohesiveZoneAction().

Member Data Documentation

◆ _base_name

const std::string CohesiveZoneAction::_base_name

protected

Base name of the material system.

Definition at line 62 of file CohesiveZoneAction.h.

Referenced by actOutputMatProp(), addBaseName(), addRequiredCZMInterfaceKernels(), and addRequiredCZMInterfaceMaterials().

◆ _boundary

const std::vector<BoundaryName> CohesiveZoneAction::_boundary

protected

Base name of the material system.

Definition at line 65 of file CohesiveZoneAction.h.

Referenced by actOutputGeneration(), actOutputMatProp(), addRequiredCZMInterfaceKernels(), addRequiredCZMInterfaceMaterials(), and chekMultipleActionParameters().

◆ _boundary_name_union

std::set<BoundaryName> CohesiveZoneAction::_boundary_name_union

protected

set generated from the combined boundary restrictions of all CohesiveZoneAction action blocks

Definition at line 94 of file CohesiveZoneAction.h.

Referenced by chekMultipleActionParameters().

◆ _component_table

const std::vector< char > CohesiveZoneActionBase::_component_table = {'x', 'y', 'z'}

staticinherited

Definition at line 32 of file CohesiveZoneActionBase.h.

Referenced by actOutputMatProp(), and CohesiveZoneActionBase::outputPropertiesType().

◆ _czm_kernel_name

std::string CohesiveZoneAction::_czm_kernel_name

protected

kernel's and materials's names

Definition at line 83 of file CohesiveZoneAction.h.

Referenced by addRelationshipManagers(), addRequiredCZMInterfaceKernels(), and CohesiveZoneAction().

◆ _diag_save_in_primary

std::vector<AuxVariableName> CohesiveZoneAction::_diag_save_in_primary

protected

Definition at line 76 of file CohesiveZoneAction.h.

Referenced by addRequiredCZMInterfaceKernels(), and CohesiveZoneAction().

◆ _diag_save_in_secondary

std::vector<AuxVariableName> CohesiveZoneAction::_diag_save_in_secondary

protected

Definition at line 78 of file CohesiveZoneAction.h.

Referenced by addRequiredCZMInterfaceKernels(), and CohesiveZoneAction().

◆ _disp_jump_provider_name

std::string CohesiveZoneAction::_disp_jump_provider_name

protected

Definition at line 84 of file CohesiveZoneAction.h.

Referenced by addRequiredCZMInterfaceMaterials(), and CohesiveZoneAction().

◆ _displacements

std::vector<VariableName> CohesiveZoneAction::_displacements

protected

the disaplcements varaible names

Definition at line 53 of file CohesiveZoneAction.h.

Referenced by addRequiredCZMInterfaceKernels(), and addRequiredCZMInterfaceMaterials().

◆ _equilibrium_traction_calculator_name

std::string CohesiveZoneAction::_equilibrium_traction_calculator_name

protected

Definition at line 85 of file CohesiveZoneAction.h.

Referenced by addRequiredCZMInterfaceMaterials(), and CohesiveZoneAction().

◆ _generate_output

std::vector<std::string> CohesiveZoneAction::_generate_output

protected

output materials to generate scalar traction/jump vector quantities

Definition at line 89 of file CohesiveZoneAction.h.

Referenced by actOutputGeneration(), actOutputMatProp(), CohesiveZoneAction(), and verifyOrderAndFamilyOutputs().

◆ _material_output_family

MultiMooseEnum CohesiveZoneAction::_material_output_family

protected

Definition at line 91 of file CohesiveZoneAction.h.

Referenced by actOutputGeneration(), and verifyOrderAndFamilyOutputs().

◆ _material_output_order

MultiMooseEnum CohesiveZoneAction::_material_output_order

protected

Definition at line 90 of file CohesiveZoneAction.h.

Referenced by actOutputGeneration(), and verifyOrderAndFamilyOutputs().

◆ _ndisp

const unsigned int CohesiveZoneAction::_ndisp

protected

number of displacement components

Definition at line 56 of file CohesiveZoneAction.h.

Referenced by act(), addRequiredCZMInterfaceKernels(), CohesiveZoneAction(), and prepareSaveInInputs().

◆ _real_vector_cartesian_component_table

const std::map< std::string, std::string > CohesiveZoneActionBase::_real_vector_cartesian_component_table

staticinherited

Initial value:

= {
        {"traction", "traction_global"},
        {"jump", "displacement_jump_global"},
        {"pk1_traction", "PK1traction"}}

table data for output generation

Definition at line 20 of file CohesiveZoneActionBase.h.

Referenced by actOutputMatProp(), CohesiveZoneActionBase::outputPropertiesType(), and setupOutput().

◆ _save_in_primary

std::vector<AuxVariableName> CohesiveZoneAction::_save_in_primary

protected

residual debugging

Definition at line 75 of file CohesiveZoneAction.h.

Referenced by addRequiredCZMInterfaceKernels(), and CohesiveZoneAction().

◆ _save_in_secondary

std::vector<AuxVariableName> CohesiveZoneAction::_save_in_secondary

protected

Definition at line 77 of file CohesiveZoneAction.h.

Referenced by addRequiredCZMInterfaceKernels(), and CohesiveZoneAction().

◆ _strain

enum CohesiveZoneAction::Strain CohesiveZoneAction::_strain

protected

Referenced by CohesiveZoneAction().

◆ _strain_formulation_union

std::set<Strain> CohesiveZoneAction::_strain_formulation_union

protected

set generated from the combined boundary restrictions of all CohesiveZoneAction action blocks

Definition at line 97 of file CohesiveZoneAction.h.

Referenced by chekMultipleActionParameters().

◆ _use_AD

const bool CohesiveZoneAction::_use_AD

protected

whether to use AD kernels and materials

Definition at line 59 of file CohesiveZoneAction.h.

Referenced by actOutputGeneration(), actOutputMatProp(), and CohesiveZoneAction().

◆ _vector_direction_table

const std::map< std::string, std::pair< std::string, std::vector< std::string > > > CohesiveZoneActionBase::_vector_direction_table

staticinherited

Initial value:

= {
        {"normal", {"Normal", {"traction", "jump"}}},
        {"tangent", {"Tangent", {"traction", "jump"}}}}

Definition at line 28 of file CohesiveZoneActionBase.h.

Referenced by actOutputMatProp(), and CohesiveZoneActionBase::outputPropertiesType().

◆ _verbose

const bool CohesiveZoneAction::_verbose

protected

display info

Definition at line 100 of file CohesiveZoneAction.h.

Referenced by verifyOrderAndFamilyOutputs().

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

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

◆ CohesiveZoneAction()

Member Function Documentation

◆ act()

◆ actOutputGeneration()

◆ actOutputMatProp()

◆ addBaseName()

◆ addRelationshipManagers() [1/3]

◆ addRelationshipManagers() [2/3]

◆ addRelationshipManagers() [3/3]

◆ addRequiredCZMInterfaceKernels()

◆ addRequiredCZMInterfaceMaterials()

◆ chekMultipleActionParameters()

◆ materialOutputFamilies()

◆ materialOutputOrders()

◆ outputPropertiesType()

◆ prepareSaveInInputs()

◆ setupOutput()

◆ validParams()

◆ verifyOrderAndFamilyOutputs()

Member Data Documentation

◆ _base_name

◆ _boundary

◆ _boundary_name_union

◆ _component_table

◆ _czm_kernel_name

◆ _diag_save_in_primary

◆ _diag_save_in_secondary

◆ _disp_jump_provider_name

◆ _displacements

◆ _equilibrium_traction_calculator_name

◆ _generate_output

◆ _material_output_family

◆ _material_output_order

◆ _ndisp

◆ _real_vector_cartesian_component_table

◆ _save_in_primary

◆ _save_in_secondary

◆ _strain

◆ _strain_formulation_union

◆ _use_AD

◆ _vector_direction_table

◆ _verbose