#include <CohesiveZoneActionBase.h>

Inheritance diagram for CohesiveZoneActionBase:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	CohesiveZoneActionBase (const InputParameters &params)

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)


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 Member Functions
bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

virtual void	act ()=0

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

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

Constructor & Destructor Documentation

◆ CohesiveZoneActionBase()

CohesiveZoneActionBase::CohesiveZoneActionBase ( const InputParameters & params )

Definition at line 100 of file CohesiveZoneActionBase.C.

                                                                             : Action(params)
{
  // 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<CommonCohesiveZoneAction>();
  if (action.size() == 1)
    pars.applyParameters(action[0]->parameters());
 
  // append additional_generate_output to generate_output
  if (isParamValid("additional_generate_output"))
  {
    MultiMooseEnum generate_output = getParam<MultiMooseEnum>("generate_output");
    MultiMooseEnum additional_generate_output =
        getParam<MultiMooseEnum>("additional_generate_output");
 
    MultiMooseEnum material_output_order = getParam<MultiMooseEnum>("material_output_order");
    MultiMooseEnum additional_material_output_order =
        getParam<MultiMooseEnum>("additional_material_output_order");
 
    MultiMooseEnum material_output_family = getParam<MultiMooseEnum>("material_output_family");
    MultiMooseEnum additional_material_output_family =
        getParam<MultiMooseEnum>("additional_material_output_family");
 
    for (auto & output : additional_generate_output)
      generate_output.setAdditionalValue(output);
    for (auto & order : additional_material_output_order)
      material_output_order.setAdditionalValue(order);
    for (auto & family : additional_material_output_family)
      material_output_family.setAdditionalValue(family);
 
    pars.set<MultiMooseEnum>("generate_output") = generate_output;
    pars.set<MultiMooseEnum>("material_output_order") = material_output_order;
    pars.set<MultiMooseEnum>("material_output_family") = material_output_family;
  }
}

Member Function Documentation

◆ materialOutputFamilies()

MultiMooseEnum CohesiveZoneActionBase::materialOutputFamilies ( )

static

Definition at line 164 of file CohesiveZoneActionBase.C.

{
  return MultiMooseEnum("MONOMIAL");
}

Referenced by validParams().

◆ materialOutputOrders()

MultiMooseEnum CohesiveZoneActionBase::materialOutputOrders ( )

static

Definition at line 156 of file CohesiveZoneActionBase.C.

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

Referenced by validParams().

◆ outputPropertiesType()

MultiMooseEnum CohesiveZoneActionBase::outputPropertiesType ( )

static

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 validParams().

◆ validParams()

InputParameters CohesiveZoneActionBase::validParams ( )

static

Definition at line 35 of file CohesiveZoneActionBase.C.

{
  InputParameters params = Action::validParams();
  params.addClassDescription("Action to create an instance of the cohesive zone model kernel for "
                             "each displacement component");
  params.addRequiredParam<std::vector<VariableName>>(
      "displacements", "The nonlinear displacement variables for the problem");
  MooseEnum strainType("SMALL FINITE", "SMALL");
  params.addParam<MooseEnum>("strain", strainType, "Strain formulation");
 
  // Advanced
  params.addParam<bool>("use_automatic_differentiation",
                        false,
                        "Whether to use automatic differentiation to compute the Jacobian");
  params.addParam<std::string>("base_name", "Material property base name");
  params.addParam<std::vector<AuxVariableName>>(
      "save_in_primary", {}, "The displacement residuals on the primary side");
  params.addParam<std::vector<AuxVariableName>>(
      "diag_save_in_primary",
      {},
      "The displacement diagonal preconditioner terms on the primary side");
  params.addParam<std::vector<AuxVariableName>>(
      "save_in_secondary", {}, "The displacement residuals on the secondary side");
  params.addParam<std::vector<AuxVariableName>>(
      "diag_save_in_secondary",
      {},
      "The displacement diagonal preconditioner terms on the secondary side");
  params.addParamNamesToGroup(
      "save_in_primary diag_save_in_primary save_in_secondary diag_save_in_secondary", "Advanced");
  params.addParam<bool>("verbose", false, "Display extra information.");
 
  // Output
  params.addParam<MultiMooseEnum>("generate_output",
                                  CohesiveZoneActionBase::outputPropertiesType(),
                                  "Add scalar quantity output for stress and/or strain");
  params.addParam<MultiMooseEnum>(
      "material_output_order",
      CohesiveZoneActionBase::materialOutputOrders(),
      "Specifies the order of the FE shape function to use for this variable.");
  params.addParam<MultiMooseEnum>(
      "material_output_family",
      CohesiveZoneActionBase::materialOutputFamilies(),
      "Specifies the family of FE shape functions to use for this variable.");
  params.addParamNamesToGroup("generate_output material_output_order material_output_family",
                              "Output");
  params.addParam<MultiMooseEnum>("additional_generate_output",
                                  CohesiveZoneActionBase::outputPropertiesType(),
                                  "Add scalar quantity output for stress and/or strain (will be "
                                  "appended to the list in `generate_output`)");
  params.addParam<MultiMooseEnum>(
      "additional_material_output_order",
      CohesiveZoneActionBase::materialOutputOrders(),
      "Specifies the order of the FE shape function to use for this variable.");
 
  params.addParam<MultiMooseEnum>(
      "additional_material_output_family",
      CohesiveZoneActionBase::materialOutputFamilies(),
      "Specifies the family of FE shape functions to use for this variable.");
 
  params.addParamNamesToGroup("additional_generate_output additional_material_output_order "
                              "additional_material_output_family",
                              "Output");
  return params;
}

Referenced by CohesiveZoneAction::validParams(), and CommonCohesiveZoneAction::validParams().

Member Data Documentation

◆ _component_table

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

static

Definition at line 32 of file CohesiveZoneActionBase.h.

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

◆ _real_vector_cartesian_component_table

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

static

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 CohesiveZoneAction::actOutputMatProp(), outputPropertiesType(), and CohesiveZoneAction::setupOutput().

◆ _vector_direction_table

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

static

Initial value:

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

Definition at line 28 of file CohesiveZoneActionBase.h.

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

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

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

◆ CohesiveZoneActionBase()

Member Function Documentation

◆ materialOutputFamilies()

◆ materialOutputOrders()

◆ outputPropertiesType()

◆ validParams()

Member Data Documentation

◆ _component_table

◆ _real_vector_cartesian_component_table

◆ _vector_direction_table