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 | Private Attributes | List of all members
BicrystalBoundingBoxICAction Class Reference

Bicrystal using a bounding box. More...

#include <BicrystalBoundingBoxICAction.h>

Inheritance diagram for BicrystalBoundingBoxICAction:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 BicrystalBoundingBoxICAction (const InputParameters &params)
 
virtual void act ()
 
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 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

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
 

Private Attributes

const std::string _var_name_base
 
const unsigned int _op_num
 

Detailed Description

Bicrystal using a bounding box.

Definition at line 18 of file BicrystalBoundingBoxICAction.h.

Constructor & Destructor Documentation

◆ BicrystalBoundingBoxICAction()

BicrystalBoundingBoxICAction::BicrystalBoundingBoxICAction ( const InputParameters params)

Definition at line 37 of file BicrystalBoundingBoxICAction.C.

38  : Action(params),
39  _var_name_base(getParam<std::string>("var_name_base")),
40  _op_num(getParam<unsigned int>("op_num"))
41 {
42  if (_op_num != 2)
43  paramError("op_num", "Must equal 2 for bicrystal ICs");
44 }
Action(const InputParameters &parameters)
void paramError(const std::string &param, Args... args) const

Member Function Documentation

◆ act()

void BicrystalBoundingBoxICAction::act ( )
virtual

Implements Action.

Definition at line 47 of file BicrystalBoundingBoxICAction.C.

48 {
49 #ifdef DEBUG
50  Moose::err << "Inside the BicrystalBoundingBoxICAction Object" << std::endl;
51 #endif
52 
53  // Loop through the number of order parameters
54  for (unsigned int op = 0; op < _op_num; ++op)
55  {
56  // Create variable names
57  const std::string var_name = _var_name_base + Moose::stringify(op);
58 
59  // Set parameters for BoundingBoxIC
60  InputParameters poly_params = _factory.getValidParams("BoundingBoxIC");
61  poly_params.applyParameters(parameters());
62  poly_params.set<VariableName>("variable") = var_name;
63  if (op == 0)
64  {
65  // Values for bounding box grain
66  poly_params.set<Real>("inside") = 1.0;
67  poly_params.set<Real>("outside") = 0.0;
68  }
69  else
70  {
71  // Values for matrix grain
72  poly_params.set<Real>("inside") = 0.0;
73  poly_params.set<Real>("outside") = 1.0;
74  }
75 
76  // Add initial condition
77  _problem->addInitialCondition(
78  "BoundingBoxIC", "BicrystalBoundingBoxIC_" + Moose::stringify(op), poly_params);
79  }
80 }
T & set(const std::string &name, bool quiet_mode=false)
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)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
std::shared_ptr< FEProblemBase > & _problem
const InputParameters & parameters() const

◆ validParams()

InputParameters BicrystalBoundingBoxICAction::validParams ( )
static

Definition at line 18 of file BicrystalBoundingBoxICAction.C.

19 {
21  params.addClassDescription("Constructs a bicrystal, where one grain is on the inside of "
22  "the box and the other grain is the outside of the box");
23  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
24  params.addRequiredParam<unsigned int>("op_num", "Number of grains, should be 2");
25  params.addRequiredParam<Real>("x1", "The x coordinate of the lower left-hand corner of the box");
26  params.addRequiredParam<Real>("y1", "The y coordinate of the lower left-hand corner of the box");
27  params.addParam<Real>("z1", 0.0, "The z coordinate of the lower left-hand corner of the box");
28  params.addRequiredParam<Real>("x2", "The x coordinate of the upper right-hand corner of the box");
29  params.addRequiredParam<Real>("y2", "The y coordinate of the upper right-hand corner of the box");
30  params.addParam<Real>("z2", 0.0, "The z coordinate of the upper right-hand corner of the box");
31  params.addParam<std::vector<SubdomainName>>("block",
32  "Block restriction for the initial condition");
33 
34  return params;
35 }
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

◆ _op_num

const unsigned int BicrystalBoundingBoxICAction::_op_num
private

Definition at line 29 of file BicrystalBoundingBoxICAction.h.

Referenced by act(), and BicrystalBoundingBoxICAction().

◆ _var_name_base

const std::string BicrystalBoundingBoxICAction::_var_name_base
private

Definition at line 28 of file BicrystalBoundingBoxICAction.h.

Referenced by act().


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