PressureAction Class Reference

#include <PressureAction.h>

Inheritance diagram for PressureAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PressureAction (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
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 &	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
PerfGraph &	perfGraph ()
std::string	getDataFileName (const std::string &param) const
std::string	getDataFileNameByName (const std::string &name, const std::string *param=nullptr) const
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const

Static Public Member Functions
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 bool	_use_ad
	Flag to use automatic differentiation. More...
std::vector< std::vector< AuxVariableName > >	_save_in_vars
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

Definition at line 14 of file PressureAction.h.

Constructor & Destructor Documentation

PressureAction()

PressureAction::PressureAction

(

const InputParameters &

params

)

Definition at line 58 of file PressureAction.C.

  : Action(params), _use_ad(getParam<bool>("use_automatic_differentiation"))
{
  _save_in_vars.push_back(getParam<std::vector<AuxVariableName>>("save_in_disp_x"));
  _save_in_vars.push_back(getParam<std::vector<AuxVariableName>>("save_in_disp_y"));
  _save_in_vars.push_back(getParam<std::vector<AuxVariableName>>("save_in_disp_z"));

  _has_save_in_vars.push_back(params.isParamValid("save_in_disp_x"));
  _has_save_in_vars.push_back(params.isParamValid("save_in_disp_y"));
  _has_save_in_vars.push_back(params.isParamValid("save_in_disp_z"));
}

Member Function Documentation

act()

void PressureAction::act ( )

overridevirtual

Implements Action.

Definition at line 71 of file PressureAction.C.

{
  std::string ad_prepend = "";
  if (_use_ad)
    ad_prepend = "AD";

  std::string kernel_name = ad_prepend + "Pressure";

  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 unique_kernel_name = kernel_name + "_" + _name + "_" + Moose::stringify(i);

    InputParameters params = _factory.getValidParams(kernel_name);
    params.applyParameters(parameters(), {"factor"});
    params.set<bool>("use_displaced_mesh") = getParam<bool>("use_displaced_mesh");
    params.set<Real>("alpha") =
        isParamValid("alpha") ? getParam<Real>("alpha") : getParam<Real>("hht_alpha");

    params.set<NonlinearVariableName>("variable") = displacements[i];

    if (_has_save_in_vars[i])
      params.set<std::vector<AuxVariableName>>("save_in") = _save_in_vars[i];

    params.set<Real>("factor") = getParam<Real>("factor");
    _problem->addBoundaryCondition(kernel_name, unique_kernel_name, params);
  }
}

validParams()

InputParameters PressureAction::validParams ( )

static

Definition at line 18 of file PressureAction.C.

{
  InputParameters params = Action::validParams();
  params.addClassDescription("Set up Pressure boundary conditions");

  params.addRequiredParam<std::vector<BoundaryName>>(
      "boundary", "The list of boundary IDs from the mesh where the pressure will be applied");

  params.addRequiredParam<std::vector<VariableName>>(
      "displacements",
      "The displacements appropriate for the simulation geometry and coordinate system");

  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<Real>("factor", 1.0, "The factor to use in computing the pressure");
  params.addParam<bool>("use_displaced_mesh", true, "Whether to use the displaced mesh.");
  params.addParam<Real>("hht_alpha",
                        0,
                        "alpha parameter for mass dependent numerical damping induced "
                        "by HHT time integration scheme");
  params.addDeprecatedParam<Real>(
      "alpha", "alpha parameter for HHT time integration", "Please use hht_alpha");
  params.addParam<FunctionName>("function", "The function that describes the pressure");
  params.addParam<bool>("use_automatic_differentiation",
                        false,
                        "Flag to use automatic differentiation (AD) objects when possible");
  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");
  return params;
}

Member Data Documentation

_has_save_in_vars

std::vector<bool> PressureAction::_has_save_in_vars

protected

Definition at line 28 of file PressureAction.h.

Referenced by act(), and PressureAction().

_save_in_vars

std::vector<std::vector<AuxVariableName> > PressureAction::_save_in_vars

protected

Definition at line 27 of file PressureAction.h.

Referenced by act(), and PressureAction().

_use_ad

const bool PressureAction::_use_ad

protected

Flag to use automatic differentiation.

Definition at line 25 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