www.mooseframework.org
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
InclinedNoDisplacementBCAction Class Reference

#include <InclinedNoDisplacementBCAction.h>

Inheritance diagram for InclinedNoDisplacementBCAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 InclinedNoDisplacementBCAction (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)
 
MooseAppgetMooseApp () 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 InputParametersparameters () 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
 
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
 
PerfGraphperfGraph ()
 
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< VariableName > _displacements
 displacement variables More...
 
unsigned int _ndisp
 number of displacement variables More...
 
std::vector< AuxVariableName > _save_in
 auxvariables to save residuals More...
 
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 InclinedNoDisplacementBCAction.h.

Constructor & Destructor Documentation

◆ InclinedNoDisplacementBCAction()

InclinedNoDisplacementBCAction::InclinedNoDisplacementBCAction ( const InputParameters params)

Definition at line 39 of file InclinedNoDisplacementBCAction.C.

40  : Action(params),
41  _use_ad(getParam<bool>("use_automatic_differentiation")),
42  _displacements(getParam<std::vector<VariableName>>("displacements")),
43  _ndisp(_displacements.size()),
44  _save_in(getParam<std::vector<AuxVariableName>>("save_in"))
45 {
46  if (_ndisp == 1)
47  mooseError("InclinedNoDisplacementBC is specific to 2D and 3D models.");
48 
49  if (_save_in.size() != 0 && _save_in.size() != _ndisp)
50  mooseError("Number of save_in variables should equal to the number of displacement variables ",
51  _displacements.size());
52 }
Action(const InputParameters &parameters)
const bool _use_ad
Flag to use automatic differentiation.
const T & getParam(const std::string &name) const
std::vector< VariableName > _displacements
displacement variables
void mooseError(Args &&... args) const
unsigned int _ndisp
number of displacement variables
std::vector< AuxVariableName > _save_in
auxvariables to save residuals

Member Function Documentation

◆ act()

void InclinedNoDisplacementBCAction::act ( )
overridevirtual

Implements Action.

Definition at line 55 of file InclinedNoDisplacementBCAction.C.

56 {
57  std::string ad_prepend = "";
58  if (_use_ad)
59  ad_prepend = "AD";
60  const std::string kernel_name = ad_prepend + "PenaltyInclinedNoDisplacementBC";
61 
62  // Create pressure BCs
63  for (unsigned int i = 0; i < _ndisp; ++i)
64  {
65  // Create unique kernel name for each of the components
66  std::string unique_kernel_name = kernel_name + "_" + _name + "_" + Moose::stringify(i);
67 
68  InputParameters params = _factory.getValidParams(kernel_name);
69  params.applyParameters(parameters());
70  params.set<bool>("use_displaced_mesh") = false;
71  params.set<unsigned int>("component") = i;
72  params.set<NonlinearVariableName>("variable") = _displacements[i];
73 
74  if (_save_in.size() == _ndisp)
75  params.set<std::vector<AuxVariableName>>("save_in") = {_save_in[i]};
76 
77  _problem->addBoundaryCondition(kernel_name, unique_kernel_name, params);
78  }
79 }
T & set(const std::string &name, bool quiet_mode=false)
const bool _use_ad
Flag to use automatic differentiation.
InputParameters getValidParams(const std::string &name) const
void applyParameters(const InputParameters &common, const std::vector< std::string > &exclude={}, const bool allow_private=false)
Factory & _factory
std::string stringify(const T &t)
std::vector< VariableName > _displacements
displacement variables
const std::string _name
std::shared_ptr< FEProblemBase > & _problem
const InputParameters & parameters() const
unsigned int _ndisp
number of displacement variables
std::vector< AuxVariableName > _save_in
auxvariables to save residuals

◆ validParams()

InputParameters InclinedNoDisplacementBCAction::validParams ( )
static

Definition at line 18 of file InclinedNoDisplacementBCAction.C.

19 {
21  params.addClassDescription("Set up inclined no displacement boundary conditions");
22 
23  params.addRequiredParam<std::vector<BoundaryName>>(
24  "boundary", "The list of boundary IDs from the mesh where the pressure will be applied");
25 
26  params.addParam<std::vector<VariableName>>(
27  "displacements",
28  {},
29  "The displacements appropriate for the simulation geometry and coordinate system");
30  params.addParam<std::vector<AuxVariableName>>("save_in", {}, "The displacement residuals");
31 
32  params.addRequiredParam<Real>("penalty", "Penalty parameter");
33  params.addParam<bool>("use_automatic_differentiation",
34  false,
35  "Flag to use automatic differentiation (AD) objects when possible");
36  return params;
37 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addRequiredParam(const std::string &name, const std::string &doc_string)
static InputParameters validParams()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _displacements

std::vector<VariableName> InclinedNoDisplacementBCAction::_displacements
protected

displacement variables

Definition at line 28 of file InclinedNoDisplacementBCAction.h.

Referenced by act(), and InclinedNoDisplacementBCAction().

◆ _ndisp

unsigned int InclinedNoDisplacementBCAction::_ndisp
protected

number of displacement variables

Definition at line 31 of file InclinedNoDisplacementBCAction.h.

Referenced by act(), and InclinedNoDisplacementBCAction().

◆ _save_in

std::vector<AuxVariableName> InclinedNoDisplacementBCAction::_save_in
protected

auxvariables to save residuals

Definition at line 34 of file InclinedNoDisplacementBCAction.h.

Referenced by act(), and InclinedNoDisplacementBCAction().

◆ _use_ad

const bool InclinedNoDisplacementBCAction::_use_ad
protected

Flag to use automatic differentiation.

Definition at line 25 of file InclinedNoDisplacementBCAction.h.

Referenced by act().


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