#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

virtual const std::string &	name () const

std::string	typeAndName () const

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

void	callMooseError (std::string msg, const bool with_prefix) const

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

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

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

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

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

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

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

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

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

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

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

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

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

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()


static MultiMooseEnum	outputPropertiesType ()
	output methods More...

static MultiMooseEnum	materialOutputOrders ()

static MultiMooseEnum	materialOutputFamilies ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
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 More...

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

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

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Detailed Description

Definition at line 14 of file 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.

Referenced by validParams().

 {
   return MultiMooseEnum("MONOMIAL");
 }

◆ materialOutputOrders()

MultiMooseEnum CohesiveZoneActionBase::materialOutputOrders ( )

static

Definition at line 156 of file CohesiveZoneActionBase.C.

Referenced by validParams().

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

◆ outputPropertiesType()

MultiMooseEnum CohesiveZoneActionBase::outputPropertiesType ( )

static

output methods

Definition at line 141 of file CohesiveZoneActionBase.C.

Referenced by validParams().

 {
   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);
 }

◆ validParams()

InputParameters CohesiveZoneActionBase::validParams ( )

static

Definition at line 35 of file CohesiveZoneActionBase.C.

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

 {
   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_master", {}, "The displacement residuals on the  master side");
   params.addParam<std::vector<AuxVariableName>>(
       "diag_save_in_master",
       {},
       "The displacement diagonal preconditioner terms on the  master side");
   params.addParam<std::vector<AuxVariableName>>(
       "save_in_slave", {}, "The displacement residuals on the  slave side");
   params.addParam<std::vector<AuxVariableName>>(
       "diag_save_in_slave",
       {},
       "The displacement diagonal preconditioner terms on the  slave side");
   params.addParamNamesToGroup("save_in_master diag_save_in_master save_in_slave diag_save_in_slave",
                               "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;
 }

Member Data Documentation

◆ _component_table

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

static

Definition at line 31 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 28 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 30 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

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