KKSAction Class Reference

Automatically generates all variables and kernels to set up a KKS phase field simulation. More...

#include <KKSAction.h>

Inheritance diagram for KKSAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	KKSAction (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)
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
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
std::string	_c_name_base

Detailed Description

Automatically generates all variables and kernels to set up a KKS phase field simulation.

Definition at line 18 of file KKSAction.h.

Constructor & Destructor Documentation

KKSAction()

KKSAction::KKSAction

(

const InputParameters &

params

)

Definition at line 27 of file KKSAction.C.

                                                   : Action(params)
// _z2(getParam<Real>("z2"))
{
}

Member Function Documentation

act()

void KKSAction::act ( )

virtual

Implements Action.

Definition at line 33 of file KKSAction.C.

{
  mooseError("Not implemented");
}

validParams()

InputParameters KKSAction::validParams ( )

static

Definition at line 16 of file KKSAction.C.

{
  InputParameters params = Action::validParams();
  params.addParam<std::string>("c_name_base", "c", "base name of the concentration variables");
  params.addParam<std::string>("eta_name", "eta", "name of the order parameter");
  params.addRequiredParam<std::vector<std::string>>("phase_names", "short names for the phases");
  params.addRequiredParam<std::vector<std::string>>("c_names",
                                                    "short names for the concentrations");
  return params;
}

Member Data Documentation

_c_name_base

std::string KKSAction::_c_name_base

private

Definition at line 27 of file KKSAction.h.

---

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

• phase_field/include/actions/KKSAction.h
• phase_field/src/actions/KKSAction.C