#include <NonconservedAction.h>

Inheritance diagram for NonconservedAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	NonconservedAction (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 *	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
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 NonlinearVariableName	_var_name
	Name of the variable being created. More...

const libMesh::FEType	_fe_type
	FEType for the variable being created. 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 18 of file NonconservedAction.h.

Constructor & Destructor Documentation

◆ NonconservedAction()

NonconservedAction::NonconservedAction ( const InputParameters & params )

Definition at line 65 of file NonconservedAction.C.

   : Action(params),
     _var_name(name()),
     _fe_type(Utility::string_to_enum<Order>(getParam<MooseEnum>("order")),
              Utility::string_to_enum<libMesh::FEFamily>(getParam<MooseEnum>("family")))
 {
 }

Member Function Documentation

◆ act()

void NonconservedAction::act ( )

virtual

Implements Action.

Definition at line 74 of file NonconservedAction.C.

 {
   //
   // Add variable
   //
   if (_current_task == "add_variable")
   {
     auto type = AddVariableAction::variableType(_fe_type);
     auto var_params = _factory.getValidParams(type);
 
     var_params.applySpecificParameters(_pars, {"family", "order", "block"});
     var_params.set<std::vector<Real>>("scaling") = {getParam<Real>("scaling")};
 
     // Create nonconserved variable
     _problem->addVariable(type, _var_name, var_params);
   }
 
   //
   // Add Kernels
   //
   else if (_current_task == "add_kernel")
   {
     // Add time derivative kernel
     std::string kernel_type = "TimeDerivative";
 
     std::string kernel_name = _var_name + "_" + kernel_type;
     InputParameters params1 = _factory.getValidParams(kernel_type);
     params1.set<NonlinearVariableName>("variable") = _var_name;
     params1.applyParameters(parameters());
 
     _problem->addKernel(kernel_type, kernel_name, params1);
 
     // Add AllenCahn kernel
     kernel_type = "AllenCahn";
 
     kernel_name = _var_name + "_" + kernel_type;
     InputParameters params2 = _factory.getValidParams(kernel_type);
     params2.set<NonlinearVariableName>("variable") = _var_name;
     params2.set<MaterialPropertyName>("mob_name") = getParam<MaterialPropertyName>("mobility");
     params2.set<MaterialPropertyName>("f_name") = getParam<MaterialPropertyName>("free_energy");
     params2.applyParameters(parameters());
 
     _problem->addKernel(kernel_type, kernel_name, params2);
 
     // Add ACInterface kernel
     kernel_type = "ACInterface";
 
     kernel_name = _var_name + "_" + kernel_type;
     InputParameters params3 = _factory.getValidParams(kernel_type);
     params3.set<NonlinearVariableName>("variable") = _var_name;
     params3.set<MaterialPropertyName>("mob_name") = getParam<MaterialPropertyName>("mobility");
     params3.set<MaterialPropertyName>("kappa_name") = getParam<MaterialPropertyName>("kappa");
     params3.set<bool>("variable_L") = getParam<bool>("variable_mobility");
     params3.applyParameters(parameters());
 
     _problem->addKernel(kernel_type, kernel_name, params3);
   }
 }

◆ validParams()

InputParameters NonconservedAction::validParams ( )

static

Definition at line 28 of file NonconservedAction.C.

 {
   InputParameters params = Action::validParams();
   params.addClassDescription(
       "Set up the variable and the kernels needed for a non-conserved phase field variable");
   // Get MooseEnums for the possible order/family options for this variable
   MooseEnum families(AddVariableAction::getNonlinearVariableFamilies());
   MooseEnum orders(AddVariableAction::getNonlinearVariableOrders());
   params.addParam<MooseEnum>("family",
                              families,
                              "Specifies the family of FE "
                              "shape functions to use for this variable");
   params.addParam<MooseEnum>("order",
                              orders,
                              "Specifies the order of the FE "
                              "shape function to use for this variable");
   params.addParam<Real>("scaling", 1.0, "Specifies a scaling factor to apply to this variable");
   params.addParam<bool>("implicit", true, "Whether kernels are implicit or not");
   params.addParam<bool>(
       "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
   params.addParamNamesToGroup("scaling implicit use_displaced_mesh", "Advanced");
   params.addParam<MaterialPropertyName>("mobility", "L", "The mobility used with the kernel");
   params.addCoupledVar("args", "Vector of nonlinear variable arguments this kernel depends on");
   params.deprecateCoupledVar("args", "coupled_variables", "02/27/2024");
   params.addRequiredParam<MaterialPropertyName>(
       "free_energy", "Base name of the free energy function F defined in a free energy material");
   params.addParam<MaterialPropertyName>("kappa", "kappa_op", "The kappa used with the kernel");
   params.addParam<bool>("variable_mobility",
                         true,
                         "The mobility is a function of any MOOSE variable (if "
                         "this is set to false, L must be constant over the "
                         "entire domain!)");
   params.addParam<std::vector<SubdomainName>>(
       "block", {}, "Block restriction for the variables and kernels");
   return params;
 }

Member Data Documentation

◆ _fe_type

const libMesh::FEType NonconservedAction::_fe_type

protected

FEType for the variable being created.

Definition at line 31 of file NonconservedAction.h.

Referenced by act().

◆ _var_name

const NonlinearVariableName NonconservedAction::_var_name

protected

Name of the variable being created.

Definition at line 29 of file NonconservedAction.h.

Referenced by act().

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

phase_field/include/actions/NonconservedAction.h
phase_field/src/actions/NonconservedAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes