Pressure boundary condition action template. More...

#include <PressureAction.h>

Inheritance diagram for PressureActionBase:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PressureActionBase (const InputParameters &params, const std::string &non_ad_pressure_bc_type, const std::string &ad_pressure_bc_type)

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

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
template<class T >
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
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

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

Protected Attributes
const std::string	_non_ad_pressure_bc_type

const std::string	_ad_pressure_bc_type

const bool	_use_ad
	Flag to use automatic differentiation. More...

const std::vector< std::vector< AuxVariableName > >	_save_in_vars

const std::vector< bool >	_has_save_in_vars

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

Pressure boundary condition action template.

The type T is used to get the valid parameters through T::actionParams(). The two strings passed into the constructor are the registred type names of teh MOOSE BC objects without and with automatic differentiation.

Definition at line 47 of file PressureAction.h.

Constructor & Destructor Documentation

◆ PressureActionBase()

PressureActionBase::PressureActionBase	(	const InputParameters &	params,
		const std::string &	non_ad_pressure_bc_type,
		const std::string &	ad_pressure_bc_type
	)

Definition at line 15 of file PressureAction.C.

   : Action(params),
     _non_ad_pressure_bc_type(non_ad_pressure_bc_type),
     _ad_pressure_bc_type(ad_pressure_bc_type),
     _use_ad(getParam<bool>("use_automatic_differentiation")),
     _save_in_vars({getParam<std::vector<AuxVariableName>>("save_in_disp_x"),
                    getParam<std::vector<AuxVariableName>>("save_in_disp_y"),
                    getParam<std::vector<AuxVariableName>>("save_in_disp_z")}),
     _has_save_in_vars({params.isParamValid("save_in_disp_x"),
                        params.isParamValid("save_in_disp_y"),
                        params.isParamValid("save_in_disp_z")})
 {
 }

Member Function Documentation

◆ act()

void PressureActionBase::act ( )

overridevirtual

Implements Action.

Definition at line 32 of file PressureAction.C.

 {
   const auto bc_type = _use_ad ? _ad_pressure_bc_type : _non_ad_pressure_bc_type;
 
   std::vector<VariableName> displacements = getParam<std::vector<VariableName>>("displacements");
   // Create pressure BCs
   for (unsigned int i = 0; i < displacements.size(); ++i)
   {
     // Create unique kernel name for each of the components
     std::string bc_name = bc_type + "_" + _name + "_" + Moose::stringify(i);
 
     InputParameters params = _factory.getValidParams(bc_type);
     params.applyParameters(parameters());
 
     params.set<NonlinearVariableName>("variable") = displacements[i];
     if (_has_save_in_vars[i])
       params.set<std::vector<AuxVariableName>>("save_in") = _save_in_vars[i];
 
     _problem->addBoundaryCondition(bc_type, bc_name, params);
 
     // The three BCs can no longer be controlled independently.
     // We agreed on PR#29603 that this was not a problem
     if (isParamValid("enable"))
       connectControllableParams("enable", bc_type, bc_name, "enable");
   }
 }

◆ validParams()

template<class T >

InputParameters PressureActionBase::validParams ( )

static

Definition at line 72 of file PressureAction.h.

 {
   InputParameters params = Action::validParams();
   params += T::actionParams();
 
   params.addParam<std::vector<BoundaryName>>(
       "boundary", "The list of boundaries (ids or names) from the mesh where this object applies");
 
   params.addClassDescription("Set up Pressure boundary conditions");
   params.addParam<bool>("use_automatic_differentiation",
                         false,
                         "Flag to use automatic differentiation (AD) objects when possible");
 
   // To make controlling the Pressure BCs easier
   params.addParam<bool>(
       "enable",
       true,
       "Set the enabled status of the BCs created by the Pressure action (defaults to true).");
   params.declareControllable("enable");
 
   // Residual output
   params.addParam<std::vector<AuxVariableName>>(
       "save_in_disp_x", {}, "The save_in variables for x displacement");
   params.addParam<std::vector<AuxVariableName>>(
       "save_in_disp_y", {}, "The save_in variables for y displacement");
   params.addParam<std::vector<AuxVariableName>>(
       "save_in_disp_z", {}, "The save_in variables for z displacement");
   params.addParam<std::vector<TagName>>("extra_vector_tags",
                                         "The extra tags for the vectors this Kernel should fill");
   params.addParam<std::vector<TagName>>(
       "absolute_value_vector_tags",
       "The tags for the vectors this residual object should fill with the "
       "absolute value of the residual contribution");
 
   params.addParam<bool>(
       "use_displaced_mesh",
       "Whether or not this object should use the displaced mesh for computation. Note that in "
       "the case this is true but no displacements are provided in the Mesh block the undisplaced "
       "mesh will still be used. For small strain formulations pressure should be applied to the "
       "undisplaced mesh to obtain agreement with analytical benchmark solutions.");
 
   params.addParamNamesToGroup(
       "save_in_disp_x save_in_disp_y save_in_disp_z extra_vector_tags absolute_value_vector_tags",
       "Residual output");
   return params;
 }

Member Data Documentation

◆ _ad_pressure_bc_type

const std::string PressureActionBase::_ad_pressure_bc_type

protected

Definition at line 61 of file PressureAction.h.

Referenced by act().

◆ _has_save_in_vars

const std::vector<bool> PressureActionBase::_has_save_in_vars

protected

Definition at line 67 of file PressureAction.h.

Referenced by act().

◆ _non_ad_pressure_bc_type

const std::string PressureActionBase::_non_ad_pressure_bc_type

protected

Definition at line 60 of file PressureAction.h.

Referenced by act().

◆ _save_in_vars

const std::vector<std::vector<AuxVariableName> > PressureActionBase::_save_in_vars

protected

Definition at line 66 of file PressureAction.h.

Referenced by act().

◆ _use_ad

const bool PressureActionBase::_use_ad

protected

Flag to use automatic differentiation.

Definition at line 64 of file PressureAction.h.

Referenced by act().

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

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

◆ PressureActionBase()

Member Function Documentation

◆ act()

◆ validParams()

Member Data Documentation

◆ _ad_pressure_bc_type

◆ _has_save_in_vars

◆ _non_ad_pressure_bc_type

◆ _save_in_vars

◆ _use_ad