Creates all the objects needed to solve a diffusion equation with a continuous Galerkin finite element discretization. More...

#include <DiffusionCG.h>

Inheritance diagram for DiffusionCG:

[legend]

Public Types
using	DataFileParameterType = DataFileName
	The parameter type this interface expects for a data file name. More...

Public Member Functions
	DiffusionCG (const InputParameters &parameters)

virtual InputParameters	getAdditionalRMParams () const
	Provide additional parameters for the relationship managers. More...

virtual void	act () override final
	Forwards from the action tasks to the implemented addXYZ() in the derived classes If you need more than these: More...

virtual void	actOnAdditionalTasks ()
	Routine to add additional setup work on additional registered tasks to a Physics. More...

void	addBlocks (const std::vector< SubdomainName > &blocks)
	Add new blocks to the Physics. More...

void	addBlocksById (const std::vector< SubdomainID > &block_ids)

const std::vector< SubdomainName > &	blocks () const
	Return the blocks this physics is defined on. More...

bool	checkBlockRestrictionIdentical (const std::string &object_name, const std::vector< SubdomainName > &blocks, const bool error_if_not_identical=true) const
	Check if an external object has the same block restriction. More...

template<typename T >
const T *	getCoupledPhysics (const PhysicsName &phys_name, const bool allow_fail=false) const
	Get a Physics from the ActionWarehouse with the requested type and name. More...

template<typename T >
const std::vector< T * >	getCoupledPhysics (const bool allow_fail=false) const
	Get all Physics from the ActionWarehouse with the requested type. More...

unsigned int	dimension () const
	Return the maximum dimension of the blocks the Physics is active on. More...

const ActionComponent &	getActionComponent (const ComponentName &comp_name) const
	Get a component with the requested name. More...

template<typename T >
void	checkComponentType (const ActionComponent &component) const
	Check that the component is of the desired type. More...

virtual void	addComponent (const ActionComponent &component)
	Most basic way of adding a component: simply adding the blocks to the block restriction of the Physics. More...

virtual void	addComponent (const ActionComponent &component) override
	Adds various info from the component. More...

const std::vector< VariableName > &	solverVariableNames () const
	Return the list of solver (nonlinear + linear) variables in this physics. More...

const std::vector< VariableName > &	auxVariableNames () const
	Return the list of aux variables in this physics. More...

void	timedAct ()
	The method called externally that causes the action to act() More...

MooseObjectName	uniqueActionName () const
	The unique name for accessing input parameters of this action in the InputParameterWarehouse. More...

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const
	Get the MooseApp this class is associated with. More...

const std::string &	type () const
	Get the type of this class. More...

virtual const std::string &	name () const
	Get the name of the class. More...

std::string	typeAndName () const
	Get the class's combined type and name; useful in error handling. More...

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const
	Calls moose error with the message `msg`. More...

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const
	The unique parameter name of a valid parameter of this object for accessing parameter controls. More...

const InputParameters &	parameters () const
	Get the parameters of the object. More...

MooseObjectName	uniqueName () const
	The unique name for accessing input parameters of this object in the InputParameterWarehouse. More...

template<typename T >
const T &	getParam (const std::string &name) const
	Retrieve a parameter for the object. More...

template<typename T1 , typename T2 >
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
	Retrieve two parameters and provide pair of parameters for the object. More...

template<typename T >
const T *	queryParam (const std::string &name) const
	Query a parameter for the object. More...

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed parameter for the object. More...

template<typename T >
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
	Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...

bool	isParamValid (const std::string &name) const
	Test if the supplied parameter is valid. More...

bool	isParamSetByUser (const std::string &nm) const
	Test if the supplied parameter is set by a user, as opposed to not set or set to default. More...

template<typename... Args>
void	paramError (const std::string &param, Args... args) const
	Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const
	Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

template<typename... Args>
void	paramInfo (const std::string &param, Args... args) const
	Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
	Connect controllable parameter of this action with the controllable parameters of the objects added by this action. More...

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type. More...

template<typename... Args>
void	mooseErrorNonPrefixed (Args &&... args) const
	Emits an error without the prefixing included in mooseError(). More...

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
	Emits a documented error with object name and type. More...

template<typename... Args>
void	mooseWarning (Args &&... args) const
	Emits a warning prefixed with object name and type. More...

template<typename... Args>
void	mooseWarningNonPrefixed (Args &&... args) const
	Emits a warning without the prefixing included in mooseWarning(). More...

template<typename... Args>
void	mooseDeprecated (Args &&... args) const

template<typename... Args>
void	mooseInfo (Args &&... args) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	getDataFileName (const std::string &param) const
	Deprecated method. More...

std::string	getDataFileNameByName (const std::string &relative_path) const
	Deprecated method. More...

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path. More...

PerfGraph &	perfGraph ()
	Get the PerfGraph. More...

void	assertParamDefined (const std::string &libmesh_dbg_var(param)) const

void	addInitialCondition (const ComponentName &component_name, const VariableName &var_name, const MooseFunctorName &ic_value)
	Add an initial condition from a component. More...

void	addBoundaryCondition (const ComponentName &component_name, const VariableName &var_name, const BoundaryName &boundary_name, const MooseFunctorName &bc_value, const ComponentBoundaryConditionInterface::BoundaryConditionType &bc_type)
	Add a boundary condition from a component. More...

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console
	An instance of helper class to write streams to the Console objects. More...

Static Public Attributes
static constexpr auto	SYSTEM = "MeshMetaData"
	The system name used when initializing the Restartable interface. More...

static constexpr auto	NAME = "<empty>"
	The data name used when initializing the Restartable interface for non-MeshGenerator objects. More...

Protected Member Functions
bool	isTransient () const
	Return whether the Physics is solved using a transient. More...

Factory &	getFactory ()
	Get the factory for this physics The factory lets you get the parameters for objects. More...

Factory &	getFactory () const

virtual FEProblemBase &	getProblem ()
	Get the problem for this physics Useful to add objects to the simulation. More...

virtual const FEProblemBase &	getProblem () const

void	prepareCopyVariablesFromMesh () const
	Tell the app if we want to use Exodus restart. More...

void	copyVariablesFromMesh (const std::vector< VariableName > &variables_to_copy, bool are_nonlinear=true)
	Copy nonlinear or aux variables from the mesh file. More...

std::string	prefix () const
	Use prefix() to disambiguate names. More...

void	saveSolverVariableName (const VariableName &var_name)
	Keep track of the name of the solver variable defined in the Physics. More...

void	saveAuxVariableName (const VariableName &var_name)
	Keep track of the name of an aux variable defined in the Physics. More...

bool	variableExists (const VariableName &var_name, bool error_if_aux) const
	Check whether a variable already exists. More...

bool	solverVariableExists (const VariableName &var_name) const
	Check whether a variable already exists and is a solver variable. More...

const SolverSystemName &	getSolverSystem (unsigned int variable_index) const
	Get the solver system for this variable index. More...

const SolverSystemName &	getSolverSystem (const VariableName &variable_name) const
	Get the solver system for this variable name. More...

void	addRequiredPhysicsTask (const std::string &task)
	Add a new required task for all physics deriving from this class NOTE: This does not register the task, you still need to call registerMooseAction. More...

void	assignBlocks (InputParameters &params, const std::vector< SubdomainName > &blocks) const
	Set the blocks parameter to the input parameters of an object this Physics will create. More...

bool	allMeshBlocks (const std::vector< SubdomainName > &blocks) const
	Check if a vector contains all the mesh blocks. More...

bool	allMeshBlocks (const std::set< SubdomainName > &blocks) const

std::set< SubdomainID >	getSubdomainIDs (const std::set< SubdomainName > &blocks) const
	Get the set of subdomain ids for the incoming vector of subdomain names. More...

std::vector< std::string >	getSubdomainNamesAndIDs (const std::set< SubdomainID > &blocks) const
	Get the vector of subdomain names and ids for the incoming set of subdomain IDs. More...

void	addPetscPairsToPetscOptions (const std::vector< std::pair< MooseEnumItem, std::string >> &petsc_pair_options)
	Process the given petsc option pairs into the system solver settings. More...

bool	isVariableFV (const VariableName &var_name) const
	Whether the variable is a finite volume variable. More...

bool	isVariableScalar (const VariableName &var_name) const
	Whether the variable is a scalar variable (global single scalar, not a field) More...

bool	shouldCreateVariable (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_aux)
	Returns whether this Physics should create the variable. More...

bool	shouldCreateIC (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool ic_is_default_ic, const bool error_if_already_defined) const
	Returns whether this Physics should create the variable. More...

bool	shouldCreateTimeDerivative (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const
	Returns whether this Physics should create the variable. More...

void	reportPotentiallyMissedParameters (const std::vector< std::string > &param_names, const std::string &object_type) const
	When this is called, we are knowingly not using the value of these parameters. More...

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
	Method to add a relationship manager for the objects being added to the system. More...

void	associateWithParameter (const std::string &param_name, InputParameters &params) const
	Associates the object's parameters `params` with the input location from this Action's parameter with the name `param_name`, if one exists. More...

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const
	The same as associateWithParameter() without `from_params`, but instead allows you to associate this with another object's parameters instead of the parameters from this action. More...

template<typename T >
const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)
	Method for retrieving a property with the given type and name exists in the mesh meta-data store. More...

template<typename T >
const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

template<typename T >
bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

template<typename T >
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
	Call to register a named section for timing. More...

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
	Call to register a named section for timing. More...

std::string	timedSectionName (const std::string &section_name) const

void	assertParamDefined (const std::string &param) const
	Check in debug mode that this parameter has been added to the validParams. More...

void	checkParamsBothSetOrNotSet (const std::string &param1, const std::string &param2) const
	Check that two parameters are either both set or both not set. More...

void	checkSecondParamSetOnlyIfFirstOneTrue (const std::string &param1, const std::string &param2) const
	Check that a parameter is set only if the first one is set to true. More...

void	checkSecondParamSetOnlyIfFirstOneSet (const std::string &param1, const std::string &param2) const
	Check that a parameter is set only if the first one is set. More...

void	checkSecondParamNotSetIfFirstOneSet (const std::string &param1, const std::string &param2) const
	Check that a parameter is not set if the first one is set. More...

void	checkVectorParamsSameLength (const std::string &param1, const std::string &param2) const
	Check that the two vector parameters are of the same length. More...

void	checkVectorParamAndMultiMooseEnumLength (const std::string &param1, const std::string &param2) const
	Check that this vector parameter (with name defined in `param1`) has the same length as the MultiMooseEnum (with name defined in `param2`) More...

void	checkTwoDVectorParamsSameLength (const std::string &param1, const std::string &param2) const
	Check that the two-D vectors have exactly the same length in both dimensions. More...

void	checkVectorParamsNoOverlap (const std::vector< std::string > &param_vecs) const
	Check that there is no overlap between the items in each vector parameters Each vector parameter should also have unique items. More...

void	checkTwoDVectorParamsNoRespectiveOverlap (const std::vector< std::string > &param_vecs) const
	Check that there is no overlap between the respective items in each vector of the two-D parameters Each vector of the two-D vector parameter should also have unique items. More...

void	checkTwoDVectorParamInnerSameLengthAsOneDVector (const std::string &param1, const std::string &param2) const
	Check that each inner vector of a two-D vector parameter are the same size as another one-D vector parameter. More...

void	checkTwoDVectorParamMultiMooseEnumSameLength (const std::string &param1, const std::string &param2, const bool error_for_param2) const
	Check that the size of a two-D vector parameter matches the size of a MultiMooseEnum parameter. More...

void	checkVectorParamNotEmpty (const std::string &param1) const
	Check that the user did not pass an empty vector. More...

void	checkVectorParamsSameLengthIfSet (const std::string &param1, const std::string &param2, const bool ignore_empty_default_param2=false) const
	Check that two vector parameters are the same length if both are set. More...

void	checkVectorParamLengthSameAsCombinedOthers (const std::string &param1, const std::string &param2, const std::string &param3) const
	Check that a vector parameter is the same length as two others combined. More...

void	checkBlockwiseConsistency (const std::string &block_param_name, const std::vector< std::string > &parameter_names) const
	Check if the user commited errors during the definition of block-wise parameters. More...

bool	parameterConsistent (const InputParameters &other_param, const std::string &param_name) const
	Return whether two parameters are consistent. More...

void	warnInconsistent (const InputParameters &parameters, const std::string &param_name) const
	Emits a warning if two parameters are not equal to each other. More...

void	errorDependentParameter (const std::string &param1, const std::string &value_not_set, const std::vector< std::string > &dependent_params) const
	Error messages for parameters that should depend on another parameter. More...

void	errorInconsistentDependentParameter (const std::string &param1, const std::string &value_set, const std::vector< std::string > &dependent_params) const
	Error messages for parameters that should depend on another parameter but with a different error message. More...

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
const VariableName &	_var_name
	Name of the diffused variable. More...

const std::vector< BoundaryName > &	_neumann_boundaries
	Boundaries on which a Neumann boundary condition is applied. More...

const std::vector< BoundaryName > &	_dirichlet_boundaries
	Boundaries on which a Dirichlet boundary condition is applied. More...

std::vector< SolverSystemName >	_system_names
	System names for the system(s) owning the solver variables. More...

std::vector< unsigned int >	_system_numbers
	System numbers for the system(s) owning the solver variables. More...

const bool	_verbose
	Whether to output additional information. More...

const MooseEnum &	_preconditioning
	Whether to add a default preconditioning. More...

std::vector< SubdomainName >	_blocks
	Keep track of the subdomains the Physics is defined on. More...

std::string	_registered_identifier

std::string	_specific_task_name
	This member will only be populated if this Action instance is only designed to handle one task. More...

std::set< std::string >	_all_tasks
	A list of all the tasks that this Action will satisfy. More...

ActionWarehouse &	_awh
	Reference to ActionWarehouse where we store object build by actions. More...

const std::string &	_current_task
	The current action (even though we have separate instances for each action) More...

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem
	Convenience reference to a problem this action works on. More...

PerfID	_act_timer
	Timers. More...

MooseApp &	_app
	The MOOSE application this is associated with. More...

const std::string	_type
	The type of this class. More...

const std::string	_name
	The name of this class. More...

const InputParameters &	_pars
	Parameters of this object, references the InputParameters stored in the InputParametersWarehouse. More...

Factory &	_factory
	The Factory associated with the MooseApp. More...

ActionFactory &	_action_factory
	Builds Actions. More...

const Parallel::Communicator &	_communicator

MooseApp &	_pg_moose_app
	The MooseApp that owns the PerfGraph. More...

const std::string	_prefix
	A prefix to use for all sections. More...

std::map< std::string, std::map< VariableName, MooseFunctorName > >	_components_initial_conditions
	Map of components to variables and initial conditions. More...

std::map< std::string, std::map< std::pair< VariableName, BoundaryName >, std::pair< MooseFunctorName, ComponentBoundaryConditionInterface::BoundaryConditionType > > >	_components_boundary_conditions
	Map of components to variables and boundary conditions. More...

Private Member Functions
virtual void	addSolverVariables () override
	The default implementation of these routines will do nothing as we do not expect all Physics to be defining an object of every type. More...

virtual void	addFEKernels () override

virtual void	addFEBCs () override

virtual void	addBoundaryConditionsFromComponents () override

Private Attributes
const bool	_use_ad
	Whether to use automatic differentiation or not. More...

Detailed Description

Creates all the objects needed to solve a diffusion equation with a continuous Galerkin finite element discretization.

Definition at line 18 of file DiffusionCG.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

The parameter type this interface expects for a data file name.

Definition at line 27 of file DataFileInterface.h.

Constructor & Destructor Documentation

◆ DiffusionCG()

DiffusionCG::DiffusionCG ( const InputParameters & parameters )

Definition at line 34 of file DiffusionCG.C.

   : PhysicsBase(parameters),
     PhysicsComponentInterface(parameters),
     DiffusionPhysicsBase(parameters),
     _use_ad(getParam<bool>("use_automatic_differentiation"))
 {
 }

Member Function Documentation

◆ act()

void PhysicsBase::act ( )

finaloverridevirtualinherited

Forwards from the action tasks to the implemented addXYZ() in the derived classes If you need more than these:

register your action to the new task using registerMooseAction("AppName", ActionClass, "task_name");
override actOnAdditionalTasks and add your additional work there

Implements Action.

Definition at line 121 of file PhysicsBase.C.

 {
   mooseDoOnce(checkRequiredTasks());
 
   // Lets a derived Physics class implement additional tasks
   actOnAdditionalTasks();
 
   // Initialization and variables
   if (_current_task == "init_physics")
     initializePhysics();
   else if (_current_task == "add_variable" && !getParam<bool>("dont_create_solver_variables"))
     addSolverVariables();
   else if (_current_task == "add_ic" && !getParam<bool>("dont_create_ics"))
     addInitialConditions();
 
   // Kernels
   else if (_current_task == "add_kernel" && !getParam<bool>("dont_create_kernels"))
     addFEKernels();
   else if (_current_task == "add_nodal_kernel" && !getParam<bool>("dont_create_kernels"))
     addNodalKernels();
   else if ((_current_task == "add_fv_kernel" || _current_task == "add_linear_fv_kernel") &&
            !getParam<bool>("dont_create_kernels"))
     addFVKernels();
   else if (_current_task == "add_dirac_kernel" && !getParam<bool>("dont_create_kernels"))
     addDiracKernels();
   else if (_current_task == "add_dg_kernel" && !getParam<bool>("dont_create_kernels"))
     addDGKernels();
   else if (_current_task == "add_scalar_kernel" && !getParam<bool>("dont_create_kernels"))
     addScalarKernels();
   else if (_current_task == "add_interface_kernel" && !getParam<bool>("dont_create_kernels"))
     addInterfaceKernels();
   else if (_current_task == "add_fv_ik" && !getParam<bool>("dont_create_kernels"))
     addFVInterfaceKernels();
 
   // Boundary conditions
   else if (_current_task == "add_bc" && !getParam<bool>("dont_create_bcs"))
     addFEBCs();
   else if (_current_task == "add_nodal_bc" && !getParam<bool>("dont_create_bcs"))
     addNodalBCs();
   else if ((_current_task == "add_fv_bc" || _current_task == "add_linear_fv_bc") &&
            !getParam<bool>("dont_create_bcs"))
     addFVBCs();
   else if (_current_task == "add_periodic_bc" && !getParam<bool>("dont_create_bcs"))
     addPeriodicBCs();
 
   // Auxiliary quantities
   else if (_current_task == "add_function" && !getParam<bool>("dont_create_functions"))
     addFunctions();
   else if (_current_task == "add_aux_variable" && !getParam<bool>("dont_create_aux_variables"))
     addAuxiliaryVariables();
   else if (_current_task == "add_aux_kernel" && !getParam<bool>("dont_create_aux_kernels"))
     addAuxiliaryKernels();
   else if (_current_task == "add_material" && !getParam<bool>("dont_create_materials"))
     addMaterials();
   else if (_current_task == "add_functor_material" && !getParam<bool>("dont_create_materials"))
     addFunctorMaterials();
 
   // Multiapp
   else if (_current_task == "add_multi_app")
     addMultiApps();
   else if (_current_task == "add_transfer")
     addTransfers();
 
   // User objects and output
   else if (_current_task == "add_user_object" && !getParam<bool>("dont_create_user_objects"))
     addUserObjects();
   else if (_current_task == "add_corrector" && !getParam<bool>("dont_create_correctors"))
     addCorrectors();
   else if (_current_task == "add_postprocessor" && !getParam<bool>("dont_create_postprocessors"))
     addPostprocessors();
   else if (_current_task == "add_vector_postprocessor" &&
            !getParam<bool>("dont_create_vectorpostprocessors"))
     addVectorPostprocessors();
   else if (_current_task == "add_reporter")
     addReporters();
   else if (_current_task == "add_output")
     addOutputs();
 
   // Equation solver-related tasks
   else if (_current_task == "add_preconditioning")
     addPreconditioning();
   else if (_current_task == "add_executioner")
     addExecutioner();
   else if (_current_task == "add_executor")
     addExecutors();
 
   // Checks
   else if (_current_task == "check_integrity_early_physics")
     checkIntegrityEarly();
   else if (_current_task == "check_integrity")
     checkIntegrity();
 
   // Exodus restart capabilities
   if (_current_task == "copy_vars_physics")
   {
     copyVariablesFromMesh(solverVariableNames(), true);
     if (_aux_var_names.size() > 0)
       copyVariablesFromMesh(auxVariableNames(), false);
   }
 }

◆ actOnAdditionalTasks()

virtual void PhysicsBase::actOnAdditionalTasks ( )

inlinevirtualinherited

Routine to add additional setup work on additional registered tasks to a Physics.

Reimplemented in PhysicsComponentInterface.

Definition at line 49 of file PhysicsBase.h.

Referenced by PhysicsBase::act().

49 {}

◆ addBlocks()

void PhysicsBase::addBlocks ( const std::vector< SubdomainName > & blocks )

inherited

Add new blocks to the Physics.

Parameters

blocks list of blocks to add to the physics

Definition at line 283 of file PhysicsBase.C.

 {
   if (blocks.size())
   {
     _blocks.insert(_blocks.end(), blocks.begin(), blocks.end());
     _dim = _mesh->getBlocksMaxDimension(_blocks);
   }
 }

◆ addBlocksById()

void PhysicsBase::addBlocksById ( const std::vector< SubdomainID > & block_ids )

inherited

Definition at line 293 of file PhysicsBase.C.

 {
   if (block_ids.size())
   {
     for (const auto bid : block_ids)
       _blocks.push_back(_mesh->getSubdomainName(bid));
     _dim = _mesh->getBlocksMaxDimension(_blocks);
   }
 }

◆ addBoundaryCondition()

void PhysicsComponentInterface::addBoundaryCondition	(	const ComponentName &	component_name,
		const VariableName &	var_name,
		const BoundaryName &	boundary_name,
		const MooseFunctorName &	bc_value,
		const ComponentBoundaryConditionInterface::BoundaryConditionType &	bc_type
	)

inherited

Add a boundary condition from a component.

Parameters

component_name	the name of the component with the boundary condition
var_name	the variable to provide the initial condition
boundary_name	the name of the boundary condition
bc_value	the functor providing the boundary condition
bc_type	the type of the boundary condition, defined in ComponentBoundaryConditionInterface at the moment

Definition at line 87 of file PhysicsComponentInterface.C.

Referenced by PhysicsComponentInterface::addComponent().

 {
   _components_boundary_conditions[component_name][std::make_pair(var_name, boundary_name)] =
       std::make_pair(bc_value, bc_type);
 }

◆ addBoundaryConditionsFromComponents()

void DiffusionCG::addBoundaryConditionsFromComponents ( )

overrideprivatevirtual

Reimplemented from PhysicsComponentInterface.

Definition at line 239 of file DiffusionCG.C.

 {
   const auto bc_type_fixed = "FunctorDirichletBC";
   InputParameters params_fixed = getFactory().getValidParams(bc_type_fixed);
   const auto bc_type_flux = "FunctorNeumannBC";
   InputParameters params_flux = getFactory().getValidParams(bc_type_flux);
 
   for (const auto & comp_pair : _components_boundary_conditions)
   {
     for (const auto & bc_pair : comp_pair.second)
     {
       params_fixed.set<NonlinearVariableName>("variable") = _var_name;
       params_flux.set<NonlinearVariableName>("variable") = _var_name;
 
       const auto bc_type = bc_pair.second.second;
       const auto functor_name = bc_pair.second.first;
       params_fixed.set<MooseFunctorName>("functor") = functor_name;
       params_flux.set<MooseFunctorName>("functor") = functor_name;
 
       const auto surface_name = bc_pair.first.second;
       params_fixed.set<std::vector<BoundaryName>>("boundary") = {surface_name};
       params_flux.set<std::vector<BoundaryName>>("boundary") = {surface_name};
 
       if (bc_type == ComponentBoundaryConditionInterface::BoundaryConditionType::FIXED_VALUE)
         getProblem().addBoundaryCondition(bc_type_fixed,
                                           prefix() + _var_name + "_comp_" + comp_pair.first +
                                               "_fixed_value_" + surface_name,
                                           params_fixed);
       else if (bc_type == ComponentBoundaryConditionInterface::BoundaryConditionType::FLUX)
         getProblem().addBoundaryCondition(bc_type_flux,
                                           prefix() + _var_name + "_comp_" + comp_pair.first +
                                               "_flux_" + surface_name,
                                           params_flux);
       else
         mooseError("Boundary condition type not implemented");
     }
   }
 }

◆ addComponent() [1/2]

void PhysicsComponentInterface::addComponent ( const ActionComponent & component )

overridevirtualinherited

Adds various info from the component.

subdomains (from PhysicsBase::addComponent)
initial conditions

Reimplemented from PhysicsBase.

Definition at line 38 of file PhysicsComponentInterface.C.

 {
   // Adds the component's blocks to the block restriction at least
   PhysicsBase::addComponent(comp);
 
   // Move initial conditions from components to the Physics
   if (const auto comp_ic = dynamic_cast<const ComponentInitialConditionInterface *>(&comp))
   {
     for (const auto & var_name : solverVariableNames())
       if (comp_ic->hasInitialCondition(var_name))
         addInitialCondition(comp.name(), var_name, comp_ic->getInitialCondition(var_name, name()));
     for (const auto & var_name : auxVariableNames())
       if (comp_ic->hasInitialCondition(var_name))
         addInitialCondition(comp.name(), var_name, comp_ic->getInitialCondition(var_name, name()));
   }
 
   // Move boundary conditions from components to the Physics
   if (const auto comp_bc = dynamic_cast<const ComponentBoundaryConditionInterface *>(&comp))
   {
     for (const auto & var_name : solverVariableNames())
       if (comp_bc->hasBoundaryCondition(var_name))
         for (const auto & boundary : comp_bc->getBoundaryConditionBoundaries(var_name))
         {
           ComponentBoundaryConditionInterface::BoundaryConditionType bc_type;
           const auto boundary_functor =
               comp_bc->getBoundaryCondition(var_name, boundary, name(), bc_type);
           addBoundaryCondition(comp.name(), var_name, boundary, boundary_functor, bc_type);
         }
     for (const auto & var_name : auxVariableNames())
       if (comp_bc->hasBoundaryCondition(var_name))
         for (const auto & boundary : comp_bc->getBoundaryConditionBoundaries(var_name))
         {
           ComponentBoundaryConditionInterface::BoundaryConditionType bc_type;
           const auto boundary_functor =
               comp_bc->getBoundaryCondition(var_name, boundary, name(), bc_type);
           addBoundaryCondition(comp.name(), var_name, boundary, boundary_functor, bc_type);
         }
   }
 }

◆ addComponent() [2/2]

void PhysicsBase::addComponent ( const ActionComponent & component )

virtualinherited

Most basic way of adding a component: simply adding the blocks to the block restriction of the Physics.

More complex behavior should be implemented by overriding

Reimplemented in PhysicsComponentInterface.

Definition at line 304 of file PhysicsBase.C.

Referenced by PhysicsComponentInterface::addComponent().

 {
   for (const auto & block : component.blocks())
     _blocks.push_back(block);
 }

◆ addFEBCs()

void DiffusionCG::addFEBCs ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 134 of file DiffusionCG.C.

 {
   if (isParamSetByUser("neumann_boundaries"))
   {
     const auto & boundary_fluxes = getParam<std::vector<MooseFunctorName>>("boundary_fluxes");
     for (const auto i : index_range(_neumann_boundaries))
     {
       const auto & bc_flux = boundary_fluxes[i];
       // Select the boundary type based on the user parameters and what we know to be most efficient
       // We could actually just use the very last option for everything but the performance is
       // better if one uses the specialized objects
       std::string bc_type = "";
       if (MooseUtils::parsesToReal(bc_flux))
         bc_type = _use_ad ? "ADNeumannBC" : "NeumannBC";
       else if (getProblem().hasVariable(bc_flux))
         bc_type = "CoupledVarNeumannBC"; // not AD, but still perfect Jacobian
       else if (getProblem().hasFunction(bc_flux))
         bc_type = _use_ad ? "ADFunctionNeumannBC" : "FunctionNeumannBC";
       else if (getProblem().hasPostprocessorValueByName(bc_flux))
         bc_type = "PostprocessorNeumannBC";
       else // this is AD, but we can mix AD and non-AD
         bc_type = "FunctorNeumannBC";
 
       // Get the parameters for the object type chosen and set the common parameters
       InputParameters params = getFactory().getValidParams(bc_type);
       params.set<NonlinearVariableName>("variable") = _var_name;
       params.set<std::vector<BoundaryName>>("boundary") = {_neumann_boundaries[i]};
 
       // Set the flux parameter for the specific type of NeumannBC used
       if (MooseUtils::parsesToReal(bc_flux))
         params.set<Real>("value") = MooseUtils::convert<Real>(bc_flux);
       else if (getProblem().hasVariable(bc_flux))
         params.set<std::vector<VariableName>>("v") = {bc_flux};
       else if (getProblem().hasFunction(bc_flux))
         params.set<FunctionName>("function") = bc_flux;
       else if (getProblem().hasPostprocessorValueByName(bc_flux))
         params.set<PostprocessorName>("postprocessor") = bc_flux;
       else
         params.set<MooseFunctorName>("functor") = bc_flux;
 
       getProblem().addBoundaryCondition(
           bc_type, prefix() + _var_name + "_neumann_bc_" + _neumann_boundaries[i], params);
     }
   }
   if (isParamSetByUser("dirichlet_boundaries"))
   {
     const auto & boundary_values = getParam<std::vector<MooseFunctorName>>("boundary_values");
     for (const auto i : index_range(_dirichlet_boundaries))
     {
       const auto & bc_value = boundary_values[i];
       // Select the boundary type based on the user parameters and what we know to be most efficient
       std::string bc_type = "";
       if (MooseUtils::parsesToReal(bc_value))
         bc_type = _use_ad ? "ADDirichletBC" : "DirichletBC";
       else if (getProblem().hasVariable(bc_value))
         bc_type = _use_ad ? "ADMatchedValueBC" : "MatchedValueBC";
       else if (getProblem().hasFunction(bc_value))
         bc_type = _use_ad ? "ADFunctionDirichletBC" : "FunctionDirichletBC";
       else if (getProblem().hasPostprocessorValueByName(bc_value))
         bc_type = "PostprocessorDirichletBC";
       else // this is AD, but we can mix AD and non-AD
         bc_type = "FunctorDirichletBC";
 
       InputParameters params = getFactory().getValidParams(bc_type);
       params.set<NonlinearVariableName>("variable") = _var_name;
       params.set<std::vector<BoundaryName>>("boundary") = {_dirichlet_boundaries[i]};
 
       // Set the flux parameter for the specific type of DirichletBC used
       if (MooseUtils::parsesToReal(bc_value))
         params.set<Real>("value") = MooseUtils::convert<Real>(bc_value);
       else if (getProblem().hasVariable(bc_value))
         params.set<std::vector<VariableName>>("v") = {bc_value};
       else if (getProblem().hasFunction(bc_value))
         params.set<FunctionName>("function") = bc_value;
       else if (getProblem().hasPostprocessorValueByName(bc_value))
         params.set<PostprocessorName>("postprocessor") = bc_value;
       else
         params.set<MooseFunctorName>("functor") = bc_value;
 
       getProblem().addBoundaryCondition(
           bc_type, prefix() + _var_name + "_dirichlet_bc_" + _dirichlet_boundaries[i], params);
     }
   }
 }

◆ addFEKernels()

void DiffusionCG::addFEKernels ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 43 of file DiffusionCG.C.

 {
   // Diffusion term
   {
     // Select the kernel type based on the user parameters
     std::string kernel_type;
     if (isParamValid("diffusivity_matprop"))
       kernel_type = _use_ad ? "ADMatDiffusion" : "MatDiffusion";
     else if (isParamValid("diffusivity_functor"))
     {
       const auto & d = getParam<MooseFunctorName>("diffusivity_functor");
       if (getProblem().hasFunction(d) || MooseUtils::parsesToReal(d))
         kernel_type = "FunctionDiffusion";
       else
         paramError("diffusivity_functor",
                    "No diffusion kernel implemented for the diffusivity type of ",
                    d);
     }
     else
       kernel_type = _use_ad ? "ADDiffusion" : "Diffusion";
     InputParameters params = getFactory().getValidParams(kernel_type);
     params.set<NonlinearVariableName>("variable") = _var_name;
     assignBlocks(params, _blocks);
 
     // Transfer the diffusivity parameter from the Physics to the kernel
     // From parameters
     if (isParamValid("diffusivity_matprop"))
       params.set<MaterialPropertyName>("diffusivity") =
           getParam<MaterialPropertyName>("diffusivity_matprop");
     else if (isParamValid("diffusivity_functor"))
       params.set<FunctionName>("function") = getParam<MooseFunctorName>("diffusivity_functor");
 
     getProblem().addKernel(kernel_type, prefix() + _var_name + "_diffusion", params);
   }
 
   // Source term
   if (isParamValid("source_functor"))
   {
     // Select the kernel type based on the user parameters
     std::string kernel_type;
     const auto & source = getParam<MooseFunctorName>("source_functor");
     if (MooseUtils::parsesToReal(source) || getProblem().hasFunction(source) ||
         getProblem().hasPostprocessorValueByName(source))
       kernel_type = _use_ad ? "ADBodyForce" : "BodyForce";
     else if (getProblem().hasVariable(source))
       kernel_type = _use_ad ? "ADCoupledForce" : "CoupledForce";
     else
       paramError("source_functor",
                  "No kernel defined for a source term in CG for the type of '",
                  source,
                  "'");
 
     InputParameters params = getFactory().getValidParams(kernel_type);
     params.set<NonlinearVariableName>("variable") = _var_name;
     assignBlocks(params, _blocks);
 
     // Transfer the source and coefficient parameter from the Physics to the kernel
     const auto coef = getParam<Real>("source_coef");
     if (MooseUtils::parsesToReal(source))
       params.set<Real>("value") = MooseUtils::convert<Real>(source) * coef;
     else if (getProblem().hasFunction(source))
     {
       params.set<Real>("value") = coef;
       params.set<FunctionName>("function") = source;
     }
     else if (getProblem().hasPostprocessorValueByName(source))
     {
       params.set<Real>("value") = coef;
       params.set<PostprocessorName>("postprocessor") = source;
     }
     else
     {
       params.set<Real>("coef") = coef;
       params.set<std::vector<VariableName>>("v") = {source};
     }
 
     getProblem().addKernel(kernel_type, prefix() + _var_name + "_source", params);
   }
 
   // Time derivative term
   if (shouldCreateTimeDerivative(_var_name, _blocks, false))
   {
     const std::string kernel_type = _use_ad ? "ADTimeDerivative" : "TimeDerivative";
     InputParameters params = getFactory().getValidParams(kernel_type);
     params.set<NonlinearVariableName>("variable") = _var_name;
     assignBlocks(params, _blocks);
     getProblem().addKernel(kernel_type, prefix() + _var_name + "_time", params);
   }
 }

◆ addInitialCondition()

void PhysicsComponentInterface::addInitialCondition	(	const ComponentName &	component_name,
		const VariableName &	var_name,
		const MooseFunctorName &	ic_value
	)

inherited

Add an initial condition from a component.

Parameters

component_name	the name of the component to set the variable IC on
var_name	the variable to provide the initial condition
ic_value	the functor providing the initial condition

Definition at line 79 of file PhysicsComponentInterface.C.

Referenced by PhysicsComponentInterface::addComponent().

 {
   _components_initial_conditions[component_name][var_name] = ic_value;
 }

◆ addPetscPairsToPetscOptions()

void PhysicsBase::addPetscPairsToPetscOptions ( const std::vector< std::pair< MooseEnumItem, std::string >> & petsc_pair_options )

protectedinherited

Process the given petsc option pairs into the system solver settings.

Definition at line 575 of file PhysicsBase.C.

Referenced by DiffusionPhysicsBase::addPreconditioning().

 {
   Moose::PetscSupport::PetscOptions & po = _problem->getPetscOptions();
   for (const auto solver_sys_num : _system_numbers)
     Moose::PetscSupport::addPetscPairsToPetscOptions(
         petsc_pair_options,
         _problem->mesh().dimension(),
         _problem->getSolverSystem(solver_sys_num).prefix(),
         *this,
         po);
 }

◆ addRelationshipManagers()

bool Action::addRelationshipManagers	(	Moose::RelationshipManagerType	when_type,
		const InputParameters &	moose_object_pars
	)

protectedinherited

Method to add a relationship manager for the objects being added to the system.

Relationship managers have to be added relatively early. In many cases before the Action::act() method is called.

Parameters

when_type	The parameter indicating the normal time for adding either Geometric or Algebraic RelationshipManagers. It may not always be possible to add your RelationshipManager as early as you'd like. In these cases, your DistributedMesh may consume more memory during the problem setup.
moose_object_pars	The MooseObject to inspect for RelationshipManagers to add

Returns: Whether a relationship manager was added

Definition at line 136 of file Action.C.

Referenced by CouplingFunctorCheckAction::act(), and PhysicsBase::addRelationshipManagers().

 {
   const auto & buildable_types = moose_object_pars.getBuildableRelationshipManagerTypes();
 
   bool added = false;
 
   for (const auto & buildable_type : buildable_types)
   {
     auto & rm_name = std::get<0>(buildable_type);
     auto & rm_type = std::get<1>(buildable_type);
     auto rm_input_parameter_func = std::get<2>(buildable_type);
 
     added = addRelationshipManager(
                 input_rm_type, moose_object_pars, rm_name, rm_type, rm_input_parameter_func) ||
             added;
   }
 
   return added;
 }

◆ addRequiredPhysicsTask()

void PhysicsBase::addRequiredPhysicsTask ( const std::string & task )

inlineprotectedinherited

Add a new required task for all physics deriving from this class NOTE: This does not register the task, you still need to call registerMooseAction.

Definition at line 158 of file PhysicsBase.h.

Referenced by DiffusionPhysicsBase::DiffusionPhysicsBase(), PhysicsBase::PhysicsBase(), and PhysicsComponentInterface::PhysicsComponentInterface().

158 { _required_tasks.insert(task); }

PhysicsBase::_required_tasks

std::set< std::string > _required_tasks

Manually keeps track of the tasks required by each physics as tasks cannot be inherited.

Definition: PhysicsBase.h:328

◆ addSolverVariables()

void DiffusionCG::addSolverVariables ( )

overrideprivatevirtual

The default implementation of these routines will do nothing as we do not expect all Physics to be defining an object of every type.

Reimplemented from PhysicsBase.

Definition at line 220 of file DiffusionCG.C.

 {
   // If the variable was added outside the Physics
   if (!shouldCreateVariable(_var_name, _blocks, true))
   {
     reportPotentiallyMissedParameters({"variable_order", "system_names"}, "MooseVariable");
     return;
   }
 
   const std::string variable_type = "MooseVariable";
   InputParameters params = getFactory().getValidParams(variable_type);
   params.set<MooseEnum>("order") = getParam<MooseEnum>("variable_order");
   assignBlocks(params, _blocks);
   params.set<SolverSystemName>("solver_sys") = getSolverSystem(_var_name);
 
   getProblem().addVariable(variable_type, _var_name, params);
 }

◆ allMeshBlocks() [1/2]

bool PhysicsBase::allMeshBlocks ( const std::vector< SubdomainName > & blocks ) const

protectedinherited

Check if a vector contains all the mesh blocks.

Parameters

blocks the vector blocks to check for whether it contains every block in the mesh

Definition at line 544 of file PhysicsBase.C.

Referenced by PhysicsBase::allMeshBlocks(), PhysicsBase::checkBlockRestrictionIdentical(), PhysicsBase::getSubdomainIDs(), and PhysicsBase::shouldCreateVariable().

 {
   mooseAssert(_mesh, "The mesh should exist already");
   // Try to return faster without examining every single block
   if (std::find(blocks.begin(), blocks.end(), "ANY_BLOCK_ID") != blocks.end())
     return true;
   else if (blocks.size() != _mesh->meshSubdomains().size())
     return false;
 
   for (const auto mesh_block : _mesh->meshSubdomains())
   {
     const auto & subdomain_name = _mesh->getSubdomainName(mesh_block);
     // Check subdomain name
     if (!subdomain_name.empty() &&
         std::find(blocks.begin(), blocks.end(), subdomain_name) == blocks.end())
       return false;
     // no subdomain name, check the IDs being used as names instead
     else if (std::find(blocks.begin(), blocks.end(), std::to_string(mesh_block)) == blocks.end())
       return false;
   }
   return true;
 }

◆ allMeshBlocks() [2/2]

bool PhysicsBase::allMeshBlocks ( const std::set< SubdomainName > & blocks ) const

protectedinherited

Definition at line 568 of file PhysicsBase.C.

 {
   std::vector<SubdomainName> blocks_vec(blocks.begin(), blocks.end());
   return allMeshBlocks(blocks_vec);
 }

◆ appendTask()

void Action::appendTask ( const std::string & task )

inlineinherited

Definition at line 104 of file Action.h.

104 { _all_tasks.insert(task); }

Action::_all_tasks

std::set< std::string > _all_tasks

A list of all the tasks that this Action will satisfy.

Definition: Action.h:156

◆ assertParamDefined() [1/2]

void InputParametersChecksUtils< PhysicsBase >::assertParamDefined ( const std::string & param ) const

protectedinherited

Check in debug mode that this parameter has been added to the validParams.

Parameters

param parameter that should be defined

◆ assertParamDefined() [2/2]

void InputParametersChecksUtils< PhysicsBase >::assertParamDefined ( const std::string & libmesh_dbg_varparam ) const

inherited

Definition at line 206 of file InputParametersChecksUtils.h.

 {
   mooseAssert(forwardParameters().template have_parameter<T>(param),
               "Parameter '" + param + "' is not defined with type '" +
                   MooseUtils::prettyCppType<T>() + "' in object type '" +
                   MooseUtils::prettyCppType(forwardType()) + "'. Check your code.");
 }

◆ assignBlocks()

void PhysicsBase::assignBlocks	(	InputParameters &	params,
		const std::vector< SubdomainName > &	blocks
	)		const

protectedinherited

Set the blocks parameter to the input parameters of an object this Physics will create.

Parameters

params	the parameters of the object
blocks	the blocks to set as the parameter

Definition at line 484 of file PhysicsBase.C.

Referenced by addFEKernels(), DiffusionFV::addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), DiffusionPhysicsBase::addInitialConditionsFromComponents(), DiffusionFV::addSolverVariables(), and addSolverVariables().

 {
   // We only set the blocks if we don't have `ANY_BLOCK_ID` defined because the subproblem
   // (through the mesh) errors out if we use this keyword during the addVariable/Kernel
   // functions
   if (std::find(blocks.begin(), blocks.end(), "ANY_BLOCK_ID") == blocks.end())
     params.set<std::vector<SubdomainName>>("block") = blocks;
   if (blocks.empty())
     mooseInfoRepeated("Empty block restriction assigned to an object created by Physics '" +
                       name() + "'.\n Did you mean to do this?");
 }

◆ associateWithParameter() [1/2]

void Action::associateWithParameter	(	const std::string &	param_name,
		InputParameters &	params
	)		const

protectedinherited

Associates the object's parameters params with the input location from this Action's parameter with the name param_name, if one exists.

For example, you have a parameter in this action of type bool with name "add_mesh". You then add an action within this action that creates a mesh if this param is true. If you call associateWithParameter("add_mesh", action_params) where action_params are the parameters for the action, we then associate that action with the "add_mesh" parameter. Therefore, the resulting created mesh will also be associated with the "add_mesh" param and any errors that are non-parameter errors (i.e., mooseError/mooseWarning) will have the line context of the "add_mesh" parameter in this action. The same goes for any errors that are produce within the created action.

Definition at line 158 of file Action.C.

Referenced by CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

 {
   associateWithParameter(parameters(), param_name, params);
 }

◆ associateWithParameter() [2/2]

void Action::associateWithParameter	(	const InputParameters &	from_params,
		const std::string &	param_name,
		InputParameters &	params
	)		const

protectedinherited

The same as associateWithParameter() without from_params, but instead allows you to associate this with another object's parameters instead of the parameters from this action.

An example here is when you want to associate the creation of an action with an argument from the application.

Definition at line 164 of file Action.C.

 {
   const auto to_hit_node = params.getHitNode();
   if (!to_hit_node || to_hit_node->isRoot())
   {
     if (const auto hit_node = from_params.getHitNode(param_name))
       params.setHitNode(*hit_node, {});
     else if (const auto hit_node = from_params.getHitNode())
       params.setHitNode(*hit_node, {});
   }
 }

◆ auxVariableNames()

const std::vector<VariableName>& PhysicsBase::auxVariableNames ( ) const

inlineinherited

Return the list of aux variables in this physics.

Definition at line 100 of file PhysicsBase.h.

Referenced by PhysicsBase::act(), and PhysicsComponentInterface::addComponent().

100 { return _aux_var_names; };

PhysicsBase::_aux_var_names

std::vector< VariableName > _aux_var_names

Vector of the aux variables in the Physics.

Definition: PhysicsBase.h:321

◆ blocks()

const std::vector<SubdomainName>& PhysicsBase::blocks ( ) const

inlineinherited

Return the blocks this physics is defined on.

Definition at line 60 of file PhysicsBase.h.

Referenced by PhysicsBase::addBlocks(), DiffusionPhysicsBase::addInitialConditionsFromComponents(), PhysicsBase::allMeshBlocks(), PhysicsBase::assignBlocks(), PhysicsBase::checkBlockRestrictionIdentical(), PhysicsBase::getSubdomainIDs(), PhysicsBase::getSubdomainNamesAndIDs(), PhysicsBase::shouldCreateIC(), PhysicsBase::shouldCreateTimeDerivative(), and PhysicsBase::shouldCreateVariable().

60 { return _blocks; }

PhysicsBase::_blocks

std::vector< SubdomainName > _blocks

Keep track of the subdomains the Physics is defined on.

Definition: PhysicsBase.h:261

◆ callMooseError()

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix
	)		const

inherited

Calls moose error with the message msg.

Will prefix the message with the subapp name if one exists.

If with_prefix, then add the prefix from errorPrefix() to the error.

Definition at line 33 of file MooseBase.C.

Referenced by InputParameters::callMooseErrorHelper(), MooseBaseErrorInterface::mooseDocumentedError(), MooseBaseErrorInterface::mooseError(), MooseBaseErrorInterface::mooseErrorNonPrefixed(), and MooseBaseParameterInterface::paramError().

 {
   _app.getOutputWarehouse().mooseConsole();
   const std::string prefix = _app.isUltimateMaster() ? "" : _app.name();
   if (with_prefix)
     msg = errorPrefix("error") + msg;
   moose::internal::mooseErrorRaw(msg, prefix);
 }

◆ checkBlockRestrictionIdentical()

bool PhysicsBase::checkBlockRestrictionIdentical	(	const std::string &	object_name,
		const std::vector< SubdomainName > &	blocks,
		const bool	error_if_not_identical = `true`
	)		const

inherited

Check if an external object has the same block restriction.

Parameters

object_name	name of the object to check the block restriction of
blocks	the blocks for this object
error_if_not_identical	whether to error if the block restrictions dont match

Definition at line 497 of file PhysicsBase.C.

 {
   // If identical, we can return fast
   if (_blocks == blocks)
     return true;
   // If one is block restricted to anywhere and the other is block restricted to anywhere manually
   if ((std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end() &&
        allMeshBlocks(blocks)) ||
       (std::find(blocks.begin(), blocks.end(), "ANY_BLOCK_ID") != blocks.end() &&
        allMeshBlocks(_blocks)))
     return true;
 
   // Copy, sort and unique is the only way to check that they are actually the same
   auto copy_blocks = _blocks;
   auto copy_blocks_other = blocks;
   std::sort(copy_blocks.begin(), copy_blocks.end());
   copy_blocks.erase(unique(copy_blocks.begin(), copy_blocks.end()), copy_blocks.end());
   std::sort(copy_blocks_other.begin(), copy_blocks_other.end());
   copy_blocks_other.erase(unique(copy_blocks_other.begin(), copy_blocks_other.end()),
                           copy_blocks_other.end());
 
   if (copy_blocks == copy_blocks_other)
     return true;
   std::vector<SubdomainName> diff;
   std::set_difference(copy_blocks.begin(),
                       copy_blocks.end(),
                       copy_blocks_other.begin(),
                       copy_blocks_other.end(),
                       std::inserter(diff, diff.begin()));
   if (error_if_not_identical)
     mooseError("Physics '",
                name(),
                "' and object '",
                object_name,
                "' have different block restrictions.\nPhysics: ",
                Moose::stringify(_blocks),
                "\nObject: ",
                Moose::stringify(blocks),
                "\nDifference: ",
                Moose::stringify(diff));
   else
     return false;
 }

◆ checkBlockwiseConsistency()

void InputParametersChecksUtils< PhysicsBase >::checkBlockwiseConsistency	(	const std::string &	block_param_name,
		const std::vector< std::string > &	parameter_names
	)		const

protectedinherited

Check if the user commited errors during the definition of block-wise parameters.

Parameters

block_param_name	the name of the parameter that provides the groups of blocks
parameter_names	vector of the names of the parameters that are defined on a per-block basis

Definition at line 483 of file InputParametersChecksUtils.h.

 {
   const std::vector<std::vector<SubdomainName>> & block_names =
       forwardGetParam<std::vector<std::vector<SubdomainName>>>(block_param_name);
 
   if (block_names.size())
   {
     // We only check block-restrictions if the customer class is not restricted to `ANY_BLOCK_ID`.
     // If the users define blocks that are not on the mesh, they will receive errors from the
     // objects created by the customer class
     const auto & object_blocks = forwardBlocks();
     if (std::find(object_blocks.begin(), object_blocks.end(), "ANY_BLOCK_ID") ==
         object_blocks.end())
       for (const auto & block_group : block_names)
         for (const auto & block : block_group)
           if (std::find(object_blocks.begin(), object_blocks.end(), block) == object_blocks.end())
             forwardParamError(block_param_name,
                               "Block '" + block + "' is not present in the block restriction of " +
                                   forwardName() +
                                   "!\nBlock restriction: " + Moose::stringify(object_blocks));
 
     for (const auto & param_name : parameter_names)
     {
       const std::vector<T> & param_vector = forwardGetParam<std::vector<T>>(param_name);
       if (block_names.size() != param_vector.size())
         forwardParamError(param_name,
                           "The number of entries in '" + param_name + "' (" +
                               std::to_string(param_vector.size()) +
                               ") is not the same as the number of blocks"
                               " (" +
                               std::to_string(block_names.size()) + ") in '" + block_param_name +
                               "'!");
     }
   }
   else
   {
     unsigned int previous_size = 0;
     for (const auto param_i : index_range(parameter_names))
     {
       const std::vector<T> & param_vector =
           forwardGetParam<std::vector<T>>(parameter_names[param_i]);
       if (param_i == 0)
       {
         if (param_vector.size() > 1)
           forwardParamError(parameter_names[param_i],
                             "The user should only use one or zero entries in " +
                                 parameter_names[param_i] + " if " + block_param_name +
                                 " not defined!");
         previous_size = param_vector.size();
       }
       else
       {
         if (previous_size != param_vector.size())
           forwardParamError(parameter_names[param_i],
                             "The number of entries in '" + parameter_names[param_i] +
                                 "' is not the same as the number of entries in '" +
                                 parameter_names[param_i - 1] + "'!");
       }
     }
   }
 }

◆ checkComponentType()

template<typename T >

void PhysicsBase::checkComponentType ( const ActionComponent & component ) const

inherited

Check that the component is of the desired type.

Definition at line 370 of file PhysicsBase.h.

 {
   if (!dynamic_cast<const T *>(&component))
     mooseError("Component '" + component.name() + "' must be of type '" +
                MooseUtils::prettyCppType<T>() + "'.\nIt is currently of type '" + component.type() +
                "'");
 }

◆ checkParamsBothSetOrNotSet()

void InputParametersChecksUtils< PhysicsBase >::checkParamsBothSetOrNotSet	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that two parameters are either both set or both not set.

Parameters

param1	first parameter to check
param2	second parameter to check

Definition at line 593 of file InputParametersChecksUtils.h.

Referenced by DiffusionPhysicsBase::DiffusionPhysicsBase().

 {
   if ((forwardIsParamValid(param1) + forwardIsParamValid(param2)) % 2 != 0)
     forwardParamError(param1,
                       "Parameters '" + param1 + "' and '" + param2 +
                           "' must be either both set or both not set.");
 }

◆ checkSecondParamNotSetIfFirstOneSet()

void InputParametersChecksUtils< PhysicsBase >::checkSecondParamNotSetIfFirstOneSet	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that a parameter is not set if the first one is set.

Parameters

param1	first parameter to check, check that the second is not if this one is set
param2	second parameter to check, that should not be set if first one is set

Definition at line 629 of file InputParametersChecksUtils.h.

 {
   if (forwardIsParamSetByUser(param1) && forwardIsParamSetByUser(param2))
     forwardParamError(param2,
                       "Parameter '" + param2 + "' should not be specified if parameter '" + param1 +
                           "' is specified.");
 }

◆ checkSecondParamSetOnlyIfFirstOneSet()

void InputParametersChecksUtils< PhysicsBase >::checkSecondParamSetOnlyIfFirstOneSet	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that a parameter is set only if the first one is set.

Parameters

param1	first parameter to check, check the second if set
param2	second parameter to check, that should be set if first one is set

Definition at line 618 of file InputParametersChecksUtils.h.

 {
   if (!forwardIsParamSetByUser(param1) && forwardIsParamSetByUser(param2))
     forwardParamError(param2,
                       "Parameter '" + param2 + "' should not be set if parameter '" + param1 +
                           "' is not specified.");
 }

◆ checkSecondParamSetOnlyIfFirstOneTrue()

void InputParametersChecksUtils< PhysicsBase >::checkSecondParamSetOnlyIfFirstOneTrue	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that a parameter is set only if the first one is set to true.

Parameters

param1	first parameter to check, check the second if true
param2	second parameter to check, that should be set if first one is true

Definition at line 604 of file InputParametersChecksUtils.h.

Referenced by PhysicsBase::PhysicsBase(), and PhysicsBase::prepareCopyVariablesFromMesh().

 {
   mooseAssert(forwardParameters().template have_parameter<bool>(param1),
               "Cannot check if parameter " + param1 +
                   " is true if it's not a bool parameter of this object");
   if (!forwardGetParam<bool>(param1) && forwardIsParamSetByUser(param2))
     forwardParamError(param2,
                       "Parameter '" + param1 + "' cannot be set to false if parameter '" + param2 +
                           "' is set by the user");
 }

◆ checkTwoDVectorParamInnerSameLengthAsOneDVector()

void InputParametersChecksUtils< PhysicsBase >::checkTwoDVectorParamInnerSameLengthAsOneDVector	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that each inner vector of a two-D vector parameter are the same size as another one-D vector parameter.

Parameters

param1	two-D vector parameter to check the dimensions of
param2	one-D vector parameter to set the desired size

Definition at line 296 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<std::vector<T>>>(param1);
   assertParamDefined<std::vector<S>>(param2);
   for (const auto & sub_vec_i : index_range(forwardGetParam<std::vector<std::vector<T>>>(param1)))
   {
     const auto size_1 = forwardGetParam<std::vector<std::vector<T>>>(param1)[sub_vec_i].size();
     const auto size_2 = forwardGetParam<std::vector<S>>(param2).size();
     if (size_1 != size_2)
       forwardParamError(param1,
                         "Vector at index " + std::to_string(sub_vec_i) + " (size " +
                             std::to_string(size_1) +
                             ") "
                             " of this parameter should be the same length as parameter '" +
                             param2 + "' (size " + std::to_string(size_2) + ")");
   }
 }

◆ checkTwoDVectorParamMultiMooseEnumSameLength()

void InputParametersChecksUtils< PhysicsBase >::checkTwoDVectorParamMultiMooseEnumSameLength	(	const std::string &	param1,
		const std::string &	param2,
		const bool	error_for_param2
	)		const

protectedinherited

Check that the size of a two-D vector parameter matches the size of a MultiMooseEnum parameter.

Parameters

param1	two-D vector parameter to check the unrolled size of
param2	MultiMooseEnum parameter to set the desired size

Definition at line 318 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<std::vector<T>>>(param1);
   assertParamDefined<MultiMooseEnum>(param2);
   const auto vec1 = forwardGetParam<std::vector<std::vector<T>>>(param1);
   const auto enum2 = forwardGetParam<MultiMooseEnum>(param2);
   const auto size_1 = vec1.empty() ? 0 : vec1.size() * vec1[0].size();
   const auto size_2 = enum2.size();
   if (size_1 != size_2)
   {
     if (error_for_param2)
       forwardParamError(param2,
                         "Vector enumeration parameter (size " + std::to_string(size_2) +
                             ") is not the same size as the vector of vector parameter '" + param1 +
                             "' (size " + std::to_string(size_1) + ")");
     else
       forwardParamError(param1,
                         "Vector of vector parameter '" + param1 + "' (total size " +
                             std::to_string(size_1) +
                             ") is not the same size as vector-enumeration parameter '" + param2 +
                             "' (size " + std::to_string(size_2) + ")");
   }
 }

◆ checkTwoDVectorParamsNoRespectiveOverlap()

void InputParametersChecksUtils< PhysicsBase >::checkTwoDVectorParamsNoRespectiveOverlap ( const std::vector< std::string > & param_vecs ) const

protectedinherited

Check that there is no overlap between the respective items in each vector of the two-D parameters Each vector of the two-D vector parameter should also have unique items.

Parameters

param_vecs vector of parameters that should not overlap with each other

Definition at line 395 of file InputParametersChecksUtils.h.

 {
   // Outer loop, each param is the name of a parameter for a vector of vectors
   for (const auto & param : param_vec)
   {
     assertParamDefined<std::vector<std::vector<T>>>(param);
     const auto & twoD_vec = forwardGetParam<std::vector<std::vector<T>>>(param);
     std::vector<std::set<T>> unique_params(twoD_vec.size());
 
     // Loop over each outer vector and compare the inner vectors respectively to other parameters
     for (const auto i : index_range(twoD_vec))
     {
       for (const auto & value : twoD_vec[i])
         if (!unique_params[i].insert(value).second)
         {
           auto copy_params = param_vec;
           copy_params.erase(std::find(copy_params.begin(), copy_params.end(), param));
           forwardMooseError("Item '" + value + "' specified in vector parameter '" + param +
                             "' is also present in one or more of the two-D vector parameters '" +
                             Moose::stringify(copy_params) +
                             "' in the inner vector of the same index, which is not allowed.");
         }
     }
   }
 }

◆ checkTwoDVectorParamsSameLength()

void InputParametersChecksUtils< PhysicsBase >::checkTwoDVectorParamsSameLength	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that the two-D vectors have exactly the same length in both dimensions.

Parameters

param1	first two-D vector parameter to check the dimensions of
param2	second two-D vector parameter to check the dimensions of

Definition at line 269 of file InputParametersChecksUtils.h.

 {
   checkVectorParamsSameLength<std::vector<T>, std::vector<S>>(param1, param2);
   if (forwardIsParamValid(param1) && forwardIsParamValid(param2))
   {
     const auto value1 = forwardGetParam<std::vector<std::vector<T>>>(param1);
     const auto value2 = forwardGetParam<std::vector<std::vector<S>>>(param2);
     for (const auto index : index_range(value1))
       if (value1[index].size() != value2[index].size())
         forwardParamError(
             param1,
             "Vector at index " + std::to_string(index) + " of 2D vector parameter '" + param1 +
                 "' is not the same size as its counterpart from 2D vector parameter '" + param2 +
                 "'.\nSize first vector: " + std::to_string(value1[index].size()) +
                 "\nSize second vector: " + std::to_string(value2[index].size()));
   }
   // handle empty vector defaults
   else if (forwardIsParamValid(param1) || forwardIsParamValid(param2))
     if (forwardGetParam<std::vector<T>>(param1).size() ||
         forwardGetParam<std::vector<T>>(param2).size())
       checkParamsBothSetOrNotSet(param1, param2);
 }

◆ checkVectorParamAndMultiMooseEnumLength()

void InputParametersChecksUtils< PhysicsBase >::checkVectorParamAndMultiMooseEnumLength	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that this vector parameter (with name defined in param1) has the same length as the MultiMooseEnum (with name defined in param2)

Parameters

param1	vector parameter to compare the size of
param2	multiMooseEnum parameter to compare the size of

Definition at line 243 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param1);
   assertParamDefined<MultiMooseEnum>(param2);
 
   if (forwardIsParamValid(param1) && forwardIsParamValid(param2))
   {
     const auto size_1 = forwardGetParam<std::vector<T>>(param1).size();
     const auto size_2 = forwardGetParam<MultiMooseEnum>(param2).size();
     if (size_1 != size_2)
       forwardParamError(param1,
                         "Vector parameters '" + param1 + "' (size " + std::to_string(size_1) +
                             ") and '" + param2 + "' (size " + std::to_string(size_2) +
                             ") must be the same size");
   }
   // handle empty vector defaults
   else if (forwardIsParamValid(param1) || forwardIsParamValid(param2))
     if (forwardGetParam<std::vector<T>>(param1).size() ||
         forwardGetParam<MultiMooseEnum>(param2).size())
       checkParamsBothSetOrNotSet(param1, param2);
 }

◆ checkVectorParamLengthSameAsCombinedOthers()

void InputParametersChecksUtils< PhysicsBase >::checkVectorParamLengthSameAsCombinedOthers	(	const std::string &	param1,
		const std::string &	param2,
		const std::string &	param3
	)		const

protectedinherited

Check that a vector parameter is the same length as two others combined.

Parameters

param1	vector parameter that provides the target size
param2	vector parameter that provides one term in the combined size
param3	vector parameter that provides one term in the combined size

Definition at line 346 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param1);
   assertParamDefined<std::vector<S>>(param2);
   assertParamDefined<std::vector<U>>(param3);
   const auto size_1 = forwardGetParam<std::vector<T>>(param1).size();
   const auto size_2 = forwardGetParam<std::vector<S>>(param2).size();
   const auto size_3 = forwardGetParam<std::vector<U>>(param3).size();
 
   if (size_1 != size_2 + size_3)
     forwardParamError(param1,
                       "Vector parameter '" + param1 + "' (size " + std::to_string(size_1) +
                           ") should be the same size as parameter '" + param2 + "' and '" + param3 +
                           " combined (total size " + std::to_string(size_2 + size_3) + ")");
 }

◆ checkVectorParamNotEmpty()

void InputParametersChecksUtils< PhysicsBase >::checkVectorParamNotEmpty ( const std::string & param1 ) const

protectedinherited

Check that the user did not pass an empty vector.

Parameters

param1 vector parameter that should not be empty

Definition at line 425 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param);
   if (!forwardGetParam<std::vector<T>>(param).size())
     forwardParamError(param, "Parameter '" + param + "' should not be set to an empty vector.");
 }

◆ checkVectorParamsNoOverlap()

void InputParametersChecksUtils< PhysicsBase >::checkVectorParamsNoOverlap ( const std::vector< std::string > & param_vecs ) const

protectedinherited

Check that there is no overlap between the items in each vector parameters Each vector parameter should also have unique items.

Parameters

param_vecs vector of parameters that should not overlap with each other

Definition at line 366 of file InputParametersChecksUtils.h.

 {
   std::set<std::string> unique_params;
   for (const auto & param : param_vec)
   {
     assertParamDefined<std::vector<T>>(param);
 
     for (const auto & value : forwardGetParam<std::vector<T>>(param))
       if (!unique_params.insert(value).second)
       {
         auto copy_params = param_vec;
         copy_params.erase(std::find(copy_params.begin(), copy_params.end(), param));
         // Overlap between multiple vectors of parameters
         if (copy_params.size())
           forwardMooseError("Item '" + value + "' specified in vector parameter '" + param +
                             "' is also present in one or more of the parameters '" +
                             Moose::stringify(copy_params) + "', which is not allowed.");
         // Overlap within a single vector parameter caused by a repeated item
         else
           forwardMooseError("Item '" + value + "' specified in vector parameter '" + param +
                             "' is repeated, which is not allowed.");
       }
   }
 }

◆ checkVectorParamsSameLength()

void InputParametersChecksUtils< PhysicsBase >::checkVectorParamsSameLength	(	const std::string &	param1,
		const std::string &	param2
	)		const

protectedinherited

Check that the two vector parameters are of the same length.

Parameters

param1	first vector parameter to compare the size of
param2	second vector parameter to compare the size of

Definition at line 217 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param1);
   assertParamDefined<std::vector<S>>(param2);
 
   if (forwardIsParamValid(param1) && forwardIsParamValid(param2))
   {
     const auto size_1 = forwardGetParam<std::vector<T>>(param1).size();
     const auto size_2 = forwardGetParam<std::vector<S>>(param2).size();
     if (size_1 != size_2)
       forwardParamError(param1,
                         "Vector parameters '" + param1 + "' (size " + std::to_string(size_1) +
                             ") and '" + param2 + "' (size " + std::to_string(size_2) +
                             ") must be the same size");
   }
   // handle empty vector defaults
   else if (forwardIsParamValid(param1) || forwardIsParamValid(param2))
     if (forwardGetParam<std::vector<T>>(param1).size() ||
         forwardGetParam<std::vector<T>>(param2).size())
       checkParamsBothSetOrNotSet(param1, param2);
 }

◆ checkVectorParamsSameLengthIfSet()

void InputParametersChecksUtils< PhysicsBase >::checkVectorParamsSameLengthIfSet	(	const std::string &	param1,
		const std::string &	param2,
		const bool	ignore_empty_default_param2 = `false`
	)		const

protectedinherited

Check that two vector parameters are the same length if both are set.

Parameters

param1	first vector parameter to check the size of
param2	second vector parameter to check the size of

Definition at line 435 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<std::vector<T>>(param1);
   assertParamDefined<std::vector<S>>(param2);
 
   if (forwardIsParamValid(param1) && forwardIsParamValid(param2))
   {
     const auto size_1 = forwardGetParam<std::vector<T>>(param1).size();
     const auto size_2 = forwardGetParam<std::vector<S>>(param2).size();
     if (ignore_empty_default_param2 && (size_2 == 0) && !forwardIsParamSetByUser(param2))
       return;
     if (size_1 != size_2)
       forwardParamError(param1,
                         "Parameter '" + param1 + "' (size " + std::to_string(size_1) + ") and '" +
                             param2 + "' (size " + std::to_string(size_2) +
                             ") must be the same size if set.");
   }
 }

◆ connectControllableParams()

void MooseBaseParameterInterface::connectControllableParams	(	const std::string &	parameter,
		const std::string &	object_type,
		const std::string &	object_name,
		const std::string &	object_parameter
	)		const

inherited

Connect controllable parameter of this action with the controllable parameters of the objects added by this action.

Parameters

parameter	Name of the controllable parameter of this action
object_type	Type of the object added by this action.
object_name	Name of the object added by this action.
object_parameter	Name of the parameter of the object.

Definition at line 33 of file MooseBaseParameterInterface.C.

 {
   MooseObjectParameterName primary_name(uniqueName(), parameter);
   const auto base_type = _factory.getValidParams(object_type).get<std::string>("_moose_base");
   MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
   _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
       primary_name, secondary_name);
 
   const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
   for (const auto & tag : tags)
   {
     if (!tag.empty())
     {
       // Only adds the parameter with the different control tags if the derived class
       // properly registers the parameter to its own syntax
       MooseObjectParameterName tagged_name(tag, _moose_base.name(), parameter);
       _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
           tagged_name, secondary_name, /*error_on_empty=*/false);
     }
   }
 }

◆ copyVariablesFromMesh()

void PhysicsBase::copyVariablesFromMesh	(	const std::vector< VariableName > &	variables_to_copy,
		bool	are_nonlinear = `true`
	)

protectedinherited

Copy nonlinear or aux variables from the mesh file.

Parameters

variables_to_copy	Nonlinear or aux (not a mix) variables
are_nonlinear	True if `variables_to_copy` are nonlinear; else, aux

Definition at line 399 of file PhysicsBase.C.

Referenced by PhysicsBase::act().

 {
   if (getParam<bool>("initialize_variables_from_mesh_file"))
   {
     mooseInfoRepeated("Adding Exodus restart for " + std::to_string(variables_to_copy.size()) +
                       " variables: " + Moose::stringify(variables_to_copy));
     // TODO Check that the variable types and orders are actually supported for exodus restart
     for (const auto i : index_range(variables_to_copy))
     {
       SystemBase & system = are_solver_var ? getProblem().getSystemBase(_system_numbers.size() == 1
                                                                             ? _system_numbers[0]
                                                                             : _system_numbers[i])
                                            : getProblem().systemBaseAuxiliary();
       const auto & var_name = variables_to_copy[i];
       system.addVariableToCopy(
           var_name, var_name, getParam<std::string>("initial_from_file_timestep"));
     }
   }
 }

◆ dimension()

unsigned int PhysicsBase::dimension ( ) const

inherited

Return the maximum dimension of the blocks the Physics is active on.

Definition at line 245 of file PhysicsBase.C.

 {
   mooseAssert(_mesh, "We dont have a mesh yet");
   mooseAssert(_dim < 4, "Dimension has not been set yet");
   return _dim;
 }

◆ errorDependentParameter()

void InputParametersChecksUtils< PhysicsBase >::errorDependentParameter	(	const std::string &	param1,
		const std::string &	value_not_set,
		const std::vector< std::string > &	dependent_params
	)		const

protectedinherited

Error messages for parameters that should depend on another parameter.

Parameters

param1	the parameter has not been set to the desired value (for logging purposes)
value_not_set	the desired value (for logging purposes)
dependent_params	all the parameters that should not have been since 'param1' was not set to 'value_not_set'

Definition at line 563 of file InputParametersChecksUtils.h.

 {
   for (const auto & dependent_param : dependent_params)
     if (forwardIsParamSetByUser(dependent_param))
       forwardParamError(dependent_param,
                         "Parameter '" + dependent_param +
                             "' should not be set by the user if parameter '" + param1 +
                             "' has not been set to '" + value_not_set + "'");
 }

◆ errorInconsistentDependentParameter()

void InputParametersChecksUtils< PhysicsBase >::errorInconsistentDependentParameter	(	const std::string &	param1,
		const std::string &	value_set,
		const std::vector< std::string > &	dependent_params
	)		const

protectedinherited

Error messages for parameters that should depend on another parameter but with a different error message.

Parameters

param1	the parameter has not been set to the desired value (for logging purposes)
value_set	the value it has been set to and which is not appropriate (for logging purposes)
dependent_params	all the parameters that should not have been set since 'param1' was set to 'value_set'

Definition at line 578 of file InputParametersChecksUtils.h.

 {
   for (const auto & dependent_param : dependent_params)
     if (forwardIsParamSetByUser(dependent_param))
       forwardParamError(dependent_param,
                         "Parameter '" + dependent_param +
                             "' should not be set by the user if parameter '" + param1 +
                             "' has been set to '" + value_set + "'");
 }

◆ errorPrefix()

std::string MooseBase::errorPrefix ( const std::string & error_type ) const

inherited

Returns: A prefix to be used in errors that contains the input file location associated with this object (if any) and the name and type of the object.

Definition at line 43 of file MooseBase.C.

Referenced by MooseBase::callMooseError(), MooseBaseErrorInterface::mooseDeprecated(), MooseBaseErrorInterface::mooseInfo(), MooseBaseErrorInterface::mooseWarning(), and MooseBaseParameterInterface::paramErrorMsg().

 {
   std::stringstream oss;
   if (const auto node = _params.getHitNode())
     if (!node->isRoot())
       oss << node->fileLocation() << ":\n";
   oss << "The following " << error_type << " occurred in the ";
   if (const auto base_ptr = _params.getBase())
     oss << *base_ptr;
   else
     oss << "object";
   oss << " '" << name() << "' of type " << type() << ".\n\n";
   return oss.str();
 }

◆ getActionComponent()

const ActionComponent & PhysicsBase::getActionComponent ( const ComponentName & comp_name ) const

inherited

Get a component with the requested name.

Definition at line 318 of file PhysicsBase.C.

Referenced by DiffusionPhysicsBase::addInitialConditions(), and DiffusionPhysicsBase::addInitialConditionsFromComponents().

 {
   return _awh.getAction<ActionComponent>(comp_name);
 }

◆ getAdditionalRMParams()

virtual InputParameters PhysicsBase::getAdditionalRMParams ( ) const

inlinevirtualinherited

Provide additional parameters for the relationship managers.

Reimplemented in DiffusionFV.

Definition at line 38 of file PhysicsBase.h.

Referenced by PhysicsBase::addRelationshipManagers().

38 { return emptyInputParameters(); };

emptyInputParameters

InputParameters emptyInputParameters()

Definition: InputParameters.C:30

◆ getAllTasks()

const std::set<std::string>& Action::getAllTasks ( ) const

inlineinherited

Definition at line 102 of file Action.h.

Referenced by AddKernelAction::act().

102 { return _all_tasks; }

Action::_all_tasks

std::set< std::string > _all_tasks

A list of all the tasks that this Action will satisfy.

Definition: Action.h:156

◆ getCheckedPointerParam()

template<typename T >

T MooseBaseParameterInterface::getCheckedPointerParam	(	const std::string &	name,
		const std::string &	error_string = `""`
	)		const

inherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 286 of file MooseBaseParameterInterface.h.

 {
   return parameters().getCheckedPointerParam<T>(name, error_string);
 }

◆ getCoupledPhysics() [1/2]

template<typename T >

const T * PhysicsBase::getCoupledPhysics	(	const PhysicsName &	phys_name,
		const bool	allow_fail = `false`
	)		const

inherited

Get a Physics from the ActionWarehouse with the requested type and name.

Parameters

phys_name	name of the Physics to retrieve
allow_fail	whether to allow returning a nullptr if the physics does not exist

Definition at line 333 of file PhysicsBase.h.

 {
   constexpr bool is_physics = std::is_base_of<PhysicsBase, T>::value;
   libmesh_ignore(is_physics);
   mooseAssert(is_physics, "Must be a PhysicsBase to be retrieved by getCoupledPhysics");
   const auto all_T_physics = _awh.getActions<T>();
   for (const auto * const physics : all_T_physics)
   {
     if (physics->name() == phys_name)
       return physics;
   }
   if (!allow_fail)
     mooseError("Requested Physics '",
                phys_name,
                "' does not exist or is not of type '",
                MooseUtils::prettyCppType<T>(),
                "'");
   else
     return nullptr;
 }

◆ getCoupledPhysics() [2/2]

template<typename T >

const std::vector< T * > PhysicsBase::getCoupledPhysics ( const bool allow_fail = false ) const

inherited

Get all Physics from the ActionWarehouse with the requested type.

Definition at line 356 of file PhysicsBase.h.

 {
   constexpr bool is_physics = std::is_base_of<PhysicsBase, T>::value;
   libmesh_ignore(is_physics);
   mooseAssert(is_physics, "Must be a PhysicsBase to be retrieved by getCoupledPhysics");
   const auto all_T_physics = _awh.getActions<T>();
   if (!allow_fail && all_T_physics.empty())
     mooseError("No Physics of requested type '", MooseUtils::prettyCppType<T>(), "'");
   else
     return all_T_physics;
 }

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                           "within the InputParameters.\nUse getParam<DataFileName>(\"",
                           param,
                           "\") instead.");
   return _parent.getParam<DataFileName>(param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                           relative_path,
                           "\") instead.");
   return getDataFilePath(relative_path);
 }

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // This should only ever be used with relative paths. There is no point to
   // use this search path with an absolute path.
   if (std::filesystem::path(relative_path).is_absolute())
     _parent.mooseWarning("While using getDataFilePath(\"",
                          relative_path,
                          "\"): This API should not be used for absolute paths.");
 
   // Throw on error so that if getPath() fails, we can throw an error
   // with the context of _parent.mooseError()
   const auto throw_on_error_before = Moose::_throw_on_error;
   Moose::_throw_on_error = true;
   std::optional<std::string> error;
 
   // This will search the data paths for this relative path
   Moose::DataFileUtils::Path found_path;
   try
   {
     found_path = Moose::DataFileUtils::getPath(relative_path);
   }
   catch (std::exception & e)
   {
     error = e.what();
   }
 
   Moose::_throw_on_error = throw_on_error_before;
   if (error)
     _parent.mooseError(*error);
 
   mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
               "Should only ever obtain data");
   mooseAssert(found_path.data_name, "Should be set");
 
   const std::string msg =
       "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
   _parent.mooseInfo(msg);
 
   return found_path.path;
 }

◆ getFactory() [1/2]

Factory& PhysicsBase::getFactory ( )

inlineprotectedinherited

Get the factory for this physics The factory lets you get the parameters for objects.

Definition at line 108 of file PhysicsBase.h.

Referenced by addBoundaryConditionsFromComponents(), addFEBCs(), addFEKernels(), DiffusionFV::addFVBCs(), DiffusionFV::addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), DiffusionPhysicsBase::addInitialConditionsFromComponents(), DiffusionFV::addSolverVariables(), addSolverVariables(), and DiffusionFV::getAdditionalRMParams().

108 { return _factory; }

MooseBaseParameterInterface::_factory

Factory & _factory

The Factory associated with the MooseApp.

Definition: MooseBaseParameterInterface.h:176

◆ getFactory() [2/2]

Factory& PhysicsBase::getFactory ( ) const

inlineprotectedinherited

Definition at line 109 of file PhysicsBase.h.

109 { return _factory; }

MooseBaseParameterInterface::_factory

Factory & _factory

The Factory associated with the MooseApp.

Definition: MooseBaseParameterInterface.h:176

◆ getMeshProperty() [1/2]

template<typename T >

const T & MeshMetaDataInterface::getMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)

protectedinherited

Method for retrieving a property with the given type and name exists in the mesh meta-data store.

This method will throw an error if the property does not exist.

Definition at line 134 of file MeshMetaDataInterface.h.

 {
   if (!hasMeshProperty(data_name, prefix))
     mooseErrorInternal("Failed to get mesh property '", prefix, "/", data_name, "'");
 
   auto value = &getMeshPropertyInternal(data_name, prefix);
   mooseAssert(value->declared(), "Value has not been declared");
   const RestartableData<T> * T_value = dynamic_cast<const RestartableData<T> *>(value);
   if (!T_value)
     mooseErrorInternal("While retrieving mesh property '",
                        prefix,
                        "/",
                        data_name,
                        "' with type '",
                        MooseUtils::prettyCppType<T>(),
                        "',\nthe property exists with different type '",
                        value->type(),
                        "'");
   return T_value->get();
 }

◆ getMeshProperty() [2/2]

template<typename T >

const T& MeshMetaDataInterface::getMeshProperty ( const std::string & data_name )

inlineprotectedinherited

Definition at line 56 of file MeshMetaDataInterface.h.

   {
     return getMeshProperty<T>(data_name, meshPropertyPrefix(data_name));
   }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 45 of file MooseBase.h.

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), MooseBaseParameterInterface::connectControllableParams(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

45 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:84

◆ getParam() [1/2]

template<typename T >

const T & MooseBaseParameterInterface::getParam ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 215 of file MooseBaseParameterInterface.h.

 {
   return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0), &_moose_base);
 }

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBaseParameterInterface::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 279 of file MooseBaseParameterInterface.h.

 {
   return _pars.get<T1, T2>(param1, param2);
 }

◆ getProblem() [1/2]

virtual FEProblemBase& PhysicsBase::getProblem ( )

inlineprotectedvirtualinherited

Get the problem for this physics Useful to add objects to the simulation.

Definition at line 112 of file PhysicsBase.h.

Referenced by addBoundaryConditionsFromComponents(), addFEBCs(), addFEKernels(), DiffusionFV::addFVBCs(), DiffusionFV::addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), DiffusionPhysicsBase::addInitialConditionsFromComponents(), DiffusionPhysicsBase::addPostprocessors(), DiffusionFV::addSolverVariables(), addSolverVariables(), PhysicsBase::checkIntegrityEarly(), PhysicsBase::copyVariablesFromMesh(), PhysicsBase::initializePhysics(), DiffusionFV::initializePhysicsAdditional(), and PhysicsBase::isTransient().

   {
     mooseAssert(_problem, "Requesting the problem too early");
     return *_problem;
   }

◆ getProblem() [2/2]

virtual const FEProblemBase& PhysicsBase::getProblem ( ) const

inlineprotectedvirtualinherited

Definition at line 117 of file PhysicsBase.h.

   {
     mooseAssert(_problem, "Requesting the problem too early");
     return *_problem;
   }

◆ getRenamedParam()

template<typename T >

const T & MooseBaseParameterInterface::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 229 of file MooseBaseParameterInterface.h.

 {
   // this enables having a default on the new parameter but bypassing it with the old one
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Second most: accept old parameter
   else if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return InputParameters::getParamHelper(old_name, _pars, static_cast<T *>(0), &_moose_base);
   // Third most: accept default for new parameter
   else if (isParamValid(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Refuse: no default, no value passed
   else if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' is being retrieved without being set.\n"
                "Did you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' may not be provided alongside former parameter '" + old_name + "'");
 }

◆ getSolverSystem() [1/2]

const SolverSystemName & PhysicsBase::getSolverSystem ( unsigned int variable_index ) const

protectedinherited

Get the solver system for this variable index.

The index should be the index of the variable in solver var_names (currently _solver_var_names) vector

Definition at line 440 of file PhysicsBase.C.

Referenced by addSolverVariables(), and DiffusionFV::addSolverVariables().

 {
   mooseAssert(!_system_names.empty(), "We should have a solver system name");
   if (_system_names.size() == 1)
     return _system_names[0];
   else
     // We trust that the system names and the variable names match one-to-one as it is enforced by
     // the checkIntegrityEarly() routine.
     return _system_names[variable_index];
 }

◆ getSolverSystem() [2/2]

const SolverSystemName & PhysicsBase::getSolverSystem ( const VariableName & variable_name ) const

protectedinherited

Get the solver system for this variable name.

Definition at line 452 of file PhysicsBase.C.

 {
   mooseAssert(!_system_names.empty(), "We should have a solver system name");
   // No need to look if only one system for the Physics
   if (_system_names.size() == 1)
     return _system_names[0];
 
   // We trust that the system names and the variable names match one-to-one as it is enforced by
   // the checkIntegrityEarly() routine.
   for (const auto variable_index : index_range(_solver_var_names))
     if (var_name == _solver_var_names[variable_index])
       return _system_names[variable_index];
   mooseError("Variable '", var_name, "' was not found within the Physics solver variables.");
 }

◆ getSubdomainIDs()

std::set< SubdomainID > PhysicsBase::getSubdomainIDs ( const std::set< SubdomainName > & blocks ) const

protectedinherited

Get the set of subdomain ids for the incoming vector of subdomain names.

Definition at line 253 of file PhysicsBase.C.

Referenced by PhysicsBase::shouldCreateIC(), and PhysicsBase::shouldCreateTimeDerivative().

 {
   const bool not_block_restricted =
       (std::find(blocks.begin(), blocks.end(), "ANY_BLOCK_ID") != blocks.end()) ||
       allMeshBlocks(blocks);
   mooseAssert(_mesh, "Should have a mesh");
   // use a set for simplicity. Note that subdomain names are unique, except maybe the empty one,
   // which cannot be specified by the user to the Physics.
   // MooseMesh::getSubdomainIDs cannot deal with the 'ANY_BLOCK_ID' name
   std::set<SubdomainID> block_ids_set =
       not_block_restricted ? _mesh->meshSubdomains() : _mesh->getSubdomainIDs(blocks);
   return block_ids_set;
 }

◆ getSubdomainNamesAndIDs()

std::vector< std::string > PhysicsBase::getSubdomainNamesAndIDs ( const std::set< SubdomainID > & blocks ) const

protectedinherited

Get the vector of subdomain names and ids for the incoming set of subdomain IDs.

Definition at line 268 of file PhysicsBase.C.

Referenced by PhysicsBase::shouldCreateIC(), and PhysicsBase::shouldCreateTimeDerivative().

 {
   mooseAssert(_mesh, "Should have a mesh");
   std::vector<std::string> sub_names_ids;
   sub_names_ids.reserve(blocks.size());
   for (const auto bid : blocks)
   {
     const auto bname = _mesh->getSubdomainName(bid);
     sub_names_ids.push_back((bname.empty() ? "(unnamed)" : bname) + " (" + std::to_string(bid) +
                             ")");
   }
   return sub_names_ids;
 }

◆ hasMeshProperty() [1/4]

bool MeshMetaDataInterface::hasMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)		const

protectedinherited

Returns: Whether or not a mesh meta-data exists.

Definition at line 25 of file MeshMetaDataInterface.C.

Referenced by MeshGenerator::declareMeshProperty(), MeshMetaDataInterface::getMeshProperty(), MeshMetaDataInterface::hasMeshProperty(), and MeshGenerator::setMeshProperty().

 {
   return _meta_data_app.hasRestartableMetaData(meshPropertyName(data_name, prefix),
                                                MooseApp::MESH_META_DATA);
 }

◆ hasMeshProperty() [2/4]

template<typename T >

bool MeshMetaDataInterface::hasMeshProperty	(	const std::string &	data_name,
		const std::string &	prefix
	)		const

protectedinherited

Returns: Whether or not a mesh meta-data exists with the given type.

Definition at line 158 of file MeshMetaDataInterface.h.

 {
   if (!hasMeshProperty(data_name, prefix))
     return false;
   const auto & value = getMeshPropertyInternal(data_name, prefix);
   return dynamic_cast<const RestartableData<T> *>(&value) != nullptr;
 }

◆ hasMeshProperty() [3/4]

bool MeshMetaDataInterface::hasMeshProperty ( const std::string & data_name ) const

inlineprotectedinherited

Returns: Whether or not a mesh meta-data exists with the default prefix.

Definition at line 74 of file MeshMetaDataInterface.h.

   {
     return hasMeshProperty(data_name, meshPropertyPrefix(data_name));
   }

◆ hasMeshProperty() [4/4]

template<typename T >

bool MeshMetaDataInterface::hasMeshProperty ( const std::string & data_name ) const

inlineprotectedinherited

Returns: Whether or not a mesh meta-data exists with the default prefix and the given type.

Definition at line 82 of file MeshMetaDataInterface.h.

   {
     return hasMeshProperty<T>(data_name, meshPropertyPrefix(data_name));
   }

◆ isParamSetByUser()

bool MooseBaseParameterInterface::isParamSetByUser ( const std::string & nm ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

nm	The name of the parameter to test

Definition at line 128 of file MooseBaseParameterInterface.h.

Referenced by SetupDebugAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), MFEMMesh::buildMesh(), LibtorchNeuralNetControl::conditionalParameterError(), DiffusionPhysicsBase::DiffusionPhysicsBase(), ElementSubdomainModifierBase::ElementSubdomainModifierBase(), MooseBaseParameterInterface::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MFEMSolverBase::setPreconditioner(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), TimedSubdomainModifier::TimedSubdomainModifier(), and XYDelaunayGenerator::XYDelaunayGenerator().

128 { return _pars.isParamSetByUser(nm); }

InputParameters::isParamSetByUser

bool isParamSetByUser(const std::string &name) const

Method returns true if the parameter was set by the user.

Definition: InputParameters.C:1178

MooseBaseParameterInterface::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseBaseParameterInterface.h:173

◆ isParamValid()

bool MooseBaseParameterInterface::isParamValid ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 122 of file MooseBaseParameterInterface.h.

Referenced by HierarchicalGridPartitioner::_do_partition(), GridPartitioner::_do_partition(), CopyNodalVarsAction::act(), SetupMeshAction::act(), SetupDebugAction::act(), ComposeTimeStepperAction::act(), SetAdaptivityOptionsAction::act(), AddVariableAction::act(), CreateDisplacedProblemAction::act(), CommonOutputAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), addFEKernels(), DiffusionFV::addFVBCs(), DiffusionFV::addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), CylinderComponent::addMeshGenerators(), AddPeriodicBCAction::AddPeriodicBCAction(), DiffusionPhysicsBase::addPostprocessors(), AdvectiveFluxAux::AdvectiveFluxAux(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayVarReductionAux::ArrayVarReductionAux(), AddPeriodicBCAction::autoTranslationBoundaries(), BicubicSplineFunction::BicubicSplineFunction(), BlockDeletionGenerator::BlockDeletionGenerator(), TimedSubdomainModifier::buildFromFile(), PiecewiseTabularBase::buildFromFile(), PiecewiseTabularBase::buildFromJSON(), ParsedChainControl::buildFunction(), GeneratedMesh::buildMesh(), MooseMesh::buildTypedMesh(), CartesianGridDivision::CartesianGridDivision(), CartesianMeshGenerator::CartesianMeshGenerator(), LibmeshPartitioner::clone(), SampledOutput::cloneMesh(), CombinerGenerator::CombinerGenerator(), FunctorAux::computeValue(), ConservativeAdvectionTempl< is_ad >::ConservativeAdvectionTempl(), CopyMeshPartitioner::CopyMeshPartitioner(), CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor(), CutMeshByLevelSetGeneratorBase::CutMeshByLevelSetGeneratorBase(), ConstantReporter::declareConstantReporterValues(), DGKernelBase::DGKernelBase(), DiffusionFluxAux::DiffusionFluxAux(), DomainUserObject::DomainUserObject(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), Eigenvalue::Eigenvalue(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), PIDTransientControl::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppUserObjectTransfer::execute(), Exodus::Exodus(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), FEProblemBase::FEProblemBase(), FEProblemSolve::FEProblemSolve(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FileOutput::FileOutput(), SpatialUserObjectVectorPostprocessor::fillPoints(), CombinerGenerator::fillPositions(), MultiApp::fillPositions(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), FunctionDT::FunctionDT(), FunctionValuePostprocessor::FunctionValuePostprocessor(), FVInterfaceKernel::FVInterfaceKernel(), FVMassMatrix::FVMassMatrix(), AddMetaDataGenerator::generate(), BreakBoundaryOnSubdomainGenerator::generate(), ElementGenerator::generate(), ExtraNodesetGenerator::generate(), FileMeshGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), SubdomainPerElementGenerator::generate(), BlockDeletionGenerator::generate(), GeneratedMeshGenerator::generate(), ParsedSubdomainGeneratorBase::generate(), MeshExtruderGenerator::generate(), ParsedExtraElementIDGenerator::generate(), XYZDelaunayGenerator::generate(), XYDelaunayGenerator::generate(), XYMeshLineCutter::generate(), SubdomainBoundingBoxGenerator::generate(), DistributedRectilinearMeshGenerator::generate(), PropertyReadFile::getFileNames(), MultiAppNearestNodeTransfer::getLocalEntitiesAndComponents(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBaseParameterInterface::getRenamedParam(), MultiAppNearestNodeTransfer::getTargetLocalNodes(), Terminator::handleMessage(), HFEMDirichletBC::HFEMDirichletBC(), EigenExecutionerBase::init(), IterationAdaptiveDT::init(), Eigenvalue::init(), AdvancedOutput::initExecutionTypes(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), MultiAppCloneReporterTransfer::initialSetup(), SolutionIC::initialSetup(), MultiAppVariableValueSampleTransfer::initialSetup(), PiecewiseTabularBase::initialSetup(), ParsedConvergence::initialSetup(), SolutionScalarAux::initialSetup(), SolutionAux::initialSetup(), Console::initialSetup(), MooseParsedVectorFunction::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedFunction::initialSetup(), SampledOutput::initSample(), IterationAdaptiveDT::IterationAdaptiveDT(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), MassMatrix::MassMatrix(), MatCoupledForce::MatCoupledForce(), MatDiffusionBase< Real >::MatDiffusionBase(), MeshGeneratorComponent::MeshGeneratorComponent(), MooseMesh::MooseMesh(), MoosePreconditioner::MoosePreconditioner(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), MooseVariableBase::MooseVariableBase(), MooseVariableFV< Real >::MooseVariableFV(), MortarConstraintBase::MortarConstraintBase(), MoveNodeGenerator::MoveNodeGenerator(), MultiApp::MultiApp(), MultiAppCloneReporterTransfer::MultiAppCloneReporterTransfer(), MultiAppGeneralFieldNearestLocationTransfer::MultiAppGeneralFieldNearestLocationTransfer(), MultiAppGeneralFieldShapeEvaluationTransfer::MultiAppGeneralFieldShapeEvaluationTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), MultiAppGeneralFieldUserObjectTransfer::MultiAppGeneralFieldUserObjectTransfer(), MultiAppPostprocessorInterpolationTransfer::MultiAppPostprocessorInterpolationTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), MultiAppReporterTransfer::MultiAppReporterTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), MultiAppVariableValueSampleTransfer::MultiAppVariableValueSampleTransfer(), MultiSystemSolveObject::MultiSystemSolveObject(), NodeSetsGeneratorBase::NodeSetsGeneratorBase(), EigenExecutionerBase::normalizeSolution(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), ParsedCurveGenerator::ParsedCurveGenerator(), PetscOutput::PetscOutput(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), PIDTransientControl::PIDTransientControl(), PiecewiseTabularBase::PiecewiseTabularBase(), PlaneIDMeshGenerator::PlaneIDMeshGenerator(), MooseMesh::prepare(), MooseBaseParameterInterface::queryParam(), MultiApp::readCommandLineArguments(), SolutionUserObjectBase::readExodusII(), ReferenceResidualInterface::ReferenceResidualInterface(), RenameBlockGenerator::RenameBlockGenerator(), ReporterPointSource::ReporterPointSource(), PhysicsBase::reportPotentiallyMissedParameters(), ParsedSubdomainMeshGenerator::setBlockName(), MooseMesh::setCoordSystem(), FileOutput::setFileBase(), FileOutput::setFileBaseInternal(), Split::setup(), SideSetsGeneratorBase::setup(), SetupMeshAction::setupMesh(), SideDiffusiveFluxIntegralTempl< is_ad, Real >::SideDiffusiveFluxIntegralTempl(), SideSetsGeneratorBase::SideSetsGeneratorBase(), SolutionUserObjectBase::SolutionUserObjectBase(), FEProblemSolve::solve(), WebServerControl::startServer(), Terminator::Terminator(), TimeIntervalTimes::TimeIntervalTimes(), TimePeriod::TimePeriod(), MultiAppDofCopyTransfer::transfer(), TransformGenerator::TransformGenerator(), FunctorIC::value(), VariableCondensationPreconditioner::VariableCondensationPreconditioner(), VectorMagnitudeFunctorMaterialTempl< is_ad >::VectorMagnitudeFunctorMaterialTempl(), WebServerControl::WebServerControl(), XYDelaunayGenerator::XYDelaunayGenerator(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

122 { return _pars.isParamValid(name); }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseBaseParameterInterface.h:173

InputParameters::isParamValid

bool isParamValid(const std::string &name) const

This method returns parameters that have been initialized in one fashion or another, i.e.

Definition: InputParameters.C:390

◆ isTransient()

bool PhysicsBase::isTransient ( ) const

protectedinherited

Return whether the Physics is solved using a transient.

Definition at line 233 of file PhysicsBase.C.

Referenced by PhysicsBase::checkIntegrityEarly(), and PhysicsBase::shouldCreateTimeDerivative().

 {
   mooseAssert(_problem, "We don't have a problem yet");
   if (_is_transient == "true")
     return true;
   else if (_is_transient == "false")
     return false;
   else
     return getProblem().isTransient();
 }

◆ isVariableFV()

bool PhysicsBase::isVariableFV ( const VariableName & var_name ) const

protectedinherited

Whether the variable is a finite volume variable.

Definition at line 589 of file PhysicsBase.C.

Referenced by PhysicsBase::shouldCreateIC().

 {
   const auto var = &_problem->getVariable(0, var_name);
   return var->isFV();
 }

◆ isVariableScalar()

bool PhysicsBase::isVariableScalar ( const VariableName & var_name ) const

protectedinherited

Whether the variable is a scalar variable (global single scalar, not a field)

Definition at line 596 of file PhysicsBase.C.

Referenced by PhysicsBase::shouldCreateIC(), and PhysicsBase::shouldCreateTimeDerivative().

 {
   return _problem->hasScalarVariable(var_name);
 }

◆ meshPropertyName() [1/2]

std::string MeshMetaDataInterface::meshPropertyName	(	const std::string &	data_name,
		const std::string &	prefix
	)

staticprotectedinherited

Returns: The full name for mesh property data.

Definition at line 33 of file MeshMetaDataInterface.C.

Referenced by MeshGenerator::declareMeshProperty(), MeshMetaDataInterface::getMeshPropertyInternal(), MeshMetaDataInterface::hasMeshProperty(), MeshMetaDataInterface::meshPropertyName(), and MeshGenerator::setMeshPropertyHelper().

 {
   return std::string(SYSTEM) + "/" + prefix + "/" + data_name;
 }

◆ meshPropertyName() [2/2]

std::string MeshMetaDataInterface::meshPropertyName ( const std::string & data_name ) const

inlineprotectedinherited

Returns: The default mesh property name for mesh property data

Definition at line 95 of file MeshMetaDataInterface.h.

   {
     return meshPropertyName(data_name, meshPropertyPrefix(data_name));
   }

◆ mooseDeprecated()

template<typename... Args>

void MooseBaseErrorInterface::mooseDeprecated ( Args &&... args ) const

inlineinherited

Definition at line 91 of file MooseBaseErrorInterface.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::getUserObjects(), FEProblemBase::hasPostprocessor(), MatDiffusionBase< Real >::MatDiffusionBase(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, _moose_base.errorPrefix("deprecation"), std::forward<Args>(args)...);
   }

◆ mooseDocumentedError()

template<typename... Args>

void MooseBaseErrorInterface::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Emits a documented error with object name and type.

Documented errors are errors that have an issue associated with them.

The repository name repo_name links a named repository to a URL and should be registered at the application level with registerRepository(). See Moose.C for an example of the "moose" repository registration.

Parameters

repo_name	The repository name where the issue resides
issue_num	The number of the issue
args	The error message to be combined

Definition at line 61 of file MooseBaseErrorInterface.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), and LowerDIntegratedBC::LowerDIntegratedBC().

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     const auto msg = moose::internal::formatMooseDocumentedError(repo_name, issue_num, oss.str());
     _moose_base.callMooseError(msg, /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

void MooseBaseErrorInterface::mooseError ( Args &&... args ) const

inlineinherited

Emits an error prefixed with object name and type.

Definition at line 29 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 40 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

void MooseBaseErrorInterface::mooseInfo ( Args &&... args ) const

inlineinherited

Definition at line 98 of file MooseBaseErrorInterface.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), PIDTransientControl::execute(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), DataFileInterface::getDataFilePath(), MFEMScalarFESpace::getFECName(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), SolutionUserObjectBase::SolutionUserObjectBase(), and SymmetryTransformGenerator::SymmetryTransformGenerator().

   {
     moose::internal::mooseInfoStream(
         _console, _moose_base.errorPrefix("information"), std::forward<Args>(args)...);
   }

◆ mooseWarning()

template<typename... Args>

void MooseBaseErrorInterface::mooseWarning ( Args &&... args ) const

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 75 of file MooseBaseErrorInterface.h.

Referenced by CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), SampledOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), MeshDiagnosticsGenerator::diagnosticsLog(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), CartesianGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), StitchedMeshGenerator::generate(), ParsedGenerateSideset::generate(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), DataFileInterface::getDataFilePath(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), CylindricalGridDivision::initialize(), SphericalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), CartesianGridDivision::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), BoundsBase::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), SampledOutput::updateSample(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

   {
     moose::internal::mooseWarningStream(
         _console, _moose_base.errorPrefix("warning"), std::forward<Args>(args)...);
   }

◆ mooseWarningNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseWarningNonPrefixed ( Args &&... args ) const

inlineinherited

Emits a warning without the prefixing included in mooseWarning().

Definition at line 85 of file MooseBaseErrorInterface.h.

   {
     moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
   }

◆ name()

virtual const std::string& MooseBase::name ( ) const

inlinevirtualinherited

Get the name of the class.

Returns: The name of the class

Reimplemented in MooseVariableBase.

Definition at line 57 of file MooseBase.h.

57 { return _name; }

MooseBase::_name

const std::string _name

The name of this class.

Definition: MooseBase.h:90

◆ paramError()

template<typename... Args>

void MooseBaseParameterInterface::paramError	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 255 of file MooseBaseParameterInterface.h.

 {
   Moose::show_trace = false;
   _moose_base.callMooseError(paramErrorMsg(param, std::forward<Args>(args)...),
                              /* with_prefix = */ false);
   Moose::show_trace = true;
 }

◆ parameterConsistent()

bool InputParametersChecksUtils< PhysicsBase >::parameterConsistent	(	const InputParameters &	other_param,
		const std::string &	param_name
	)		const

protectedinherited

Return whether two parameters are consistent.

Parameters

other_param	InputParameters object from another object to check the 'param_name' parameter in
param_name	the name of the parameter to check for consistency

Definition at line 460 of file InputParametersChecksUtils.h.

 {
   assertParamDefined<T>(param_name);
   mooseAssert(other_param.have_parameter<T>(param_name),
               "This should have been a parameter from the parameters being compared");
   bool consistent = true;
   if (forwardParameters().isParamValid(param_name) && other_param.isParamValid(param_name))
   {
     if constexpr (std::is_same_v<MooseEnum, T>)
     {
       if (!forwardGetParam<T>(param_name).compareCurrent(other_param.get<T>(param_name)))
         consistent = false;
     }
     else if (forwardGetParam<T>(param_name) != other_param.get<T>(param_name))
       consistent = false;
   }
   return consistent;
 }

◆ parameters()

const InputParameters& MooseBaseParameterInterface::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 62 of file MooseBaseParameterInterface.h.

62 { return _pars; }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition: MooseBaseParameterInterface.h:173

◆ paramInfo()

template<typename... Args>

void MooseBaseParameterInterface::paramInfo	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 272 of file MooseBaseParameterInterface.h.

Referenced by GridPartitioner::_do_partition(), ComboMarker::ComboMarker(), FunctorIC::FunctorIC(), and TransientMultiApp::TransientMultiApp().

 {
   mooseInfo(paramErrorMsg(param, std::forward<Args>(args)...));
 }

◆ paramWarning()

template<typename... Args>

void MooseBaseParameterInterface::paramWarning	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 265 of file MooseBaseParameterInterface.h.

Referenced by GridPartitioner::_do_partition(), EigenProblem::checkProblemIntegrity(), CombinerGenerator::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

 {
   mooseWarning(paramErrorMsg(param, std::forward<Args>(args)...));
 }

◆ perfGraph()

PerfGraph & PerfGraphInterface::perfGraph ( )

inherited

Get the PerfGraph.

Definition at line 78 of file PerfGraphInterface.C.

Referenced by CommonOutputAction::act(), PerfGraphData::finalize(), and PerfGraphOutput::output().

 {
   return _pg_moose_app.perfGraph();
 }

◆ prefix()

std::string PhysicsBase::prefix ( ) const

inlineprotectedinherited

Use prefix() to disambiguate names.

Definition at line 135 of file PhysicsBase.h.

Referenced by addBoundaryConditionsFromComponents(), addFEBCs(), addFEKernels(), DiffusionFV::addFVBCs(), DiffusionFV::addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), DiffusionPhysicsBase::addInitialConditionsFromComponents(), and DiffusionPhysicsBase::addPostprocessors().

135 { return name() + "_"; }

MooseBase::name

virtual const std::string & name() const

Get the name of the class.

Definition: MooseBase.h:57

◆ prepareCopyVariablesFromMesh()

void PhysicsBase::prepareCopyVariablesFromMesh ( ) const

protectedinherited

Tell the app if we want to use Exodus restart.

Definition at line 223 of file PhysicsBase.C.

Referenced by PhysicsBase::PhysicsBase().

 {
   if (getParam<bool>("initialize_variables_from_mesh_file"))
     _app.setExodusFileRestart(true);
 
   checkSecondParamSetOnlyIfFirstOneTrue("initialize_variables_from_mesh_file",
                                         "initial_from_file_timestep");
 }

◆ queryParam()

template<typename T >

const T * MooseBaseParameterInterface::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 222 of file MooseBaseParameterInterface.h.

 {
   return isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

◆ registerTimedSection() [1/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns: The ID of the section - use when starting timing

Definition at line 53 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(timed_section_name, level);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ registerTimedSection() [2/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level,
		const std::string &	live_message,
		const bool	print_dots = `true`
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)
live_message	The message to be printed to the screen during execution
print_dots	Whether or not progress dots should be printed for this section

Returns: The ID of the section - use when starting timing

Definition at line 64 of file PerfGraphInterface.C.

 {
   const auto timed_section_name = timedSectionName(section_name);
   if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
     return moose::internal::getPerfGraphRegistry().registerSection(
         timedSectionName(section_name), level, live_message, print_dots);
   else
     return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
 }

◆ reportPotentiallyMissedParameters()

void PhysicsBase::reportPotentiallyMissedParameters	(	const std::vector< std::string > &	param_names,
		const std::string &	object_type
	)		const

protectedinherited

When this is called, we are knowingly not using the value of these parameters.

This routine checks whether these parameters simply have defaults or were passed by the user

Parameters

param_names the parameters we are ignoring

Definition at line 779 of file PhysicsBase.C.

Referenced by addSolverVariables(), and DiffusionFV::addSolverVariables().

 {
   std::vector<std::string> defaults_unused;
   std::vector<std::string> user_values_unused;
   for (const auto & param : param_names)
   {
     if (isParamSetByUser(param))
       user_values_unused.push_back(param);
     else if (isParamValid(param))
       defaults_unused.push_back(param);
   }
   if (defaults_unused.size() && _verbose)
     mooseInfoRepeated("Defaults for parameters '" + Moose::stringify(defaults_unused) +
                       "' for object of type '" + object_type +
                       "' were not used because the object was not created by this Physics.");
   if (user_values_unused.size())
   {
     if (_app.unusedFlagIsWarning())
       mooseWarning(
           "User-specifed values for parameters '" + Moose::stringify(user_values_unused) +
           "' for object of type '" + object_type +
           "' were not used because the corresponding object was not created by this Physics.");
     else if (_app.unusedFlagIsError())
       mooseError(
           "User-specified values for parameters '" + Moose::stringify(user_values_unused) +
           "' for object of type '" + object_type +
           "' were not used because the corresponding object was not created by this Physics.");
   }
 }

◆ saveAuxVariableName()

void PhysicsBase::saveAuxVariableName ( const VariableName & var_name )

inlineprotectedinherited

Keep track of the name of an aux variable defined in the Physics.

Definition at line 143 of file PhysicsBase.h.

143 { _aux_var_names.push_back(var_name); }

PhysicsBase::_aux_var_names

std::vector< VariableName > _aux_var_names

Vector of the aux variables in the Physics.

Definition: PhysicsBase.h:321

◆ saveSolverVariableName()

void PhysicsBase::saveSolverVariableName ( const VariableName & var_name )

inlineprotectedinherited

Keep track of the name of the solver variable defined in the Physics.

Definition at line 138 of file PhysicsBase.h.

Referenced by DiffusionPhysicsBase::DiffusionPhysicsBase().

   {
     _solver_var_names.push_back(var_name);
   }

◆ shouldCreateIC()

bool PhysicsBase::shouldCreateIC	(	const VariableName &	var_name,
		const std::vector< SubdomainName > &	blocks,
		const bool	ic_is_default_ic,
		const bool	error_if_already_defined
	)		const

protectedinherited

Returns whether this Physics should create the variable.

Will return false if the initial condition already exists and has the necessary block restriction.

Parameters

var_name	name of the variable
blocks	block restriction to use. If empty, no block restriction
ic_is_default_ic	whether this IC is from a default parameter, and therefore should be skipped when recovering/restarting
error_if_already_defined	two ICs cannot be defined on the same subdomain, so if this is set to true, any overlap between the subdomains of two ICs for the same variable will cause an error. If set to false, the existing ICs will take priority, and this routine will return false. Setting 'error_if_already_defined' to '!ic_is_default_ic' is a good idea if it is ok to overwrite the default IC value of the Physics.

Definition at line 626 of file PhysicsBase.C.

Referenced by DiffusionPhysicsBase::addInitialConditions().

 {
   // Handle recover
   if (ic_is_default_ic && (_app.isRestarting() || _app.isRecovering()))
     return false;
   // do not set initial conditions if we are loading fields from the mesh file
   if (getParam<bool>("initialize_variables_from_mesh_file"))
     return false;
   // Different type of ICs, not block restrictable
   mooseAssert(!isVariableScalar(var_name), "shouldCreateIC not implemented for scalar variables");
 
   // Process the desired block restriction into a set of subdomain IDs
   std::set<SubdomainName> blocks_set(blocks.begin(), blocks.end());
   const auto blocks_ids_set = getSubdomainIDs(blocks_set);
 
   // Check whether there are any ICs for this variable already in the problem
   std::set<SubdomainID> blocks_ids_covered;
   bool has_all_blocks;
   if (isVariableFV(var_name))
     has_all_blocks = _problem->getFVInitialConditionWarehouse().hasObjectsForVariableAndBlocks(
         var_name, blocks_ids_set, blocks_ids_covered, /*tid =*/0);
   else
     has_all_blocks = _problem->getInitialConditionWarehouse().hasObjectsForVariableAndBlocks(
         var_name, blocks_ids_set, blocks_ids_covered, /*tid =*/0);
 
   const bool has_some_blocks = !blocks_ids_covered.empty();
   if (!has_some_blocks)
     return true;
 
   if (has_all_blocks)
   {
     if (error_if_already_defined)
       mooseError("ICs for variable '" + var_name + "' have already been defined for blocks '" +
                  Moose::stringify(blocks) + "'.");
     else
       return false;
   }
 
   // Partial overlap between Physics is not implemented.
   mooseError("There is a partial overlap between the subdomains covered by pre-existing initial "
              "conditions (ICs), defined on blocks (ids): " +
              Moose::stringify(getSubdomainNamesAndIDs(blocks_ids_covered)) +
              "\n and a newly created IC for variable " + var_name +
              ", to be defined on blocks: " + Moose::stringify(blocks) +
              ".\nWe should be creating the Physics' IC only for non-covered blocks. This is not "
              "implemented at this time.");
 }

◆ shouldCreateTimeDerivative()

bool PhysicsBase::shouldCreateTimeDerivative	(	const VariableName &	var_name,
		const std::vector< SubdomainName > &	blocks,
		const bool	error_if_already_defined
	)		const

protectedinherited

Returns whether this Physics should create the variable.

Will return false if the time derivative kernel already exists and has the necessary block restriction.

Parameters

var_name	name of the variable
blocks	block restriction to use. If empty, no block restriction
error_if_already_defined	two time derivatives can be defined on the same subdomain, but it is usually not correct. So if this is set to true, any overlap between the subdomains of two time derivatives for the same variable will cause an error. If set to false, the existing time derivative will be deemed as sufficient, and this routine will return false.

Definition at line 678 of file PhysicsBase.C.

Referenced by addFEKernels(), and DiffusionFV::addFVKernels().

 {
   // Follow the transient setting of the Physics
   if (!isTransient())
     return false;
 
   // Variable is either nonlinear (FV/FE), nodal nonlinear (field of ODEs), linear, or scalar.
   // The warehouses hosting the time kernels are different for each of these types
   // Different type of time derivatives, not block restrictable
   mooseAssert(!isVariableScalar(var_name),
               "shouldCreateTimeDerivative not implemented for scalar variables");
   mooseAssert(!_problem->hasAuxiliaryVariable(var_name),
               "Should not be called with auxiliary variables");
 
   // Get solver system type
   const auto var = &_problem->getVariable(0, var_name);
   const auto var_id = var->number();
   const auto sys_num = var->sys().number();
   const auto time_vector_tag =
       (sys_num < _problem->numNonlinearSystems())
           ? var->sys().timeVectorTag()
           // this is not quite correct. Many kernels can contribute to RHS time vector on paper
           : dynamic_cast<LinearSystem *>(&var->sys())->rightHandSideTimeVectorTag();
 
   // We just use the warehouse, it should cover every time derivative object type
   bool all_blocks_covered = true;
   std::set<SubdomainID> blocks_ids_covered;
   // we examine subdomain by subdomain, because mutiple kernels could be covering every block in
   // the 'blocks' parameter
   for (const auto & block : blocks)
   {
     std::vector<MooseObject *> time_kernels;
     if (block != "ANY_BLOCK_ID")
     {
       const auto bid = _mesh->getSubdomainID(block);
       _problem->theWarehouse()
           .query()
           .template condition<AttribSysNum>(sys_num)
           .template condition<AttribVar>(var_id)
           .template condition<AttribSubdomains>(bid)
           // we use the time tag as a proxy for time derivatives
           .template condition<AttribVectorTags>(time_vector_tag)
           .queryInto(time_kernels);
     }
     else
       _problem->theWarehouse()
           .query()
           .template condition<AttribSysNum>(sys_num)
           .template condition<AttribVar>(var_id)
           // we use the time tag as a proxy for time derivatives
           .template condition<AttribVectorTags>(time_vector_tag)
           .queryInto(time_kernels);
 
     if (time_kernels.size())
     {
       if (block == "ANY_BLOCK_ID")
       {
         for (const auto & time_kernel : time_kernels)
           if (const auto blk = dynamic_cast<BlockRestrictable *>(time_kernel))
             blocks_ids_covered.insert(blk->blockIDs().begin(), blk->blockIDs().end());
       }
       else
         blocks_ids_covered.insert(_mesh->getSubdomainID(block));
     }
     else
       all_blocks_covered = false;
   }
 
   // From the set of covered blocks, see if the blocks we needed are found
   if (all_blocks_covered)
   {
     std::set<SubdomainName> blocks_set(blocks.begin(), blocks.end());
     const auto blocks_ids = getSubdomainIDs(blocks_set);
     if (blocks_ids != blocks_ids_covered)
       all_blocks_covered = false;
   }
   const bool has_some_blocks = !blocks_ids_covered.empty();
   if (!has_some_blocks)
     return true;
   if (all_blocks_covered)
   {
     if (error_if_already_defined)
       mooseError("A time kernel for variable '" + var_name +
                  "' has already been defined on blocks '" + Moose::stringify(blocks) + "'.");
     else
       return false;
   }
 
   // Partial overlap between Physics is not implemented.
   mooseError("There is a partial overlap between the subdomains covered by pre-existing time "
              "derivative kernel(s), defined on blocks (ids): " +
              Moose::stringify(getSubdomainNamesAndIDs(blocks_ids_covered)) +
              "\nand a newly created time derivative kernel for variable " + var_name +
              ", to be defined on blocks: " + Moose::stringify(blocks) +
              ".\nWe should be creating the Physics' time derivative only for non-covered "
              "blocks. This is not implemented at this time.");
 }

◆ shouldCreateVariable()

bool PhysicsBase::shouldCreateVariable	(	const VariableName &	var_name,
		const std::vector< SubdomainName > &	blocks,
		const bool	error_if_aux
	)

protectedinherited

Returns whether this Physics should create the variable.

Will return false if the variable already exists and has the necessary block restriction.

Parameters

var_name	name of the variable
blocks	block restriction to use. If empty, no block restriction
error_if_aux	error if the variable is auxiliary

Definition at line 602 of file PhysicsBase.C.

Referenced by addSolverVariables(), and DiffusionFV::addSolverVariables().

 {
   if (!variableExists(var_name, error_if_aux))
     return true;
   // check block restriction
   auto & var = _problem->getVariable(0, var_name);
   const bool not_block_restricted =
       (std::find(blocks.begin(), blocks.end(), "ANY_BLOCK_ID") != blocks.end()) ||
       allMeshBlocks(blocks);
   if (!var.blockRestricted() || (!not_block_restricted && var.hasBlocks(blocks)))
     return false;
 
   // This is an edge case, which might warrant a warning
   if (allMeshBlocks(var.blocks()) && not_block_restricted)
     return false;
   else
     mooseError("Variable '" + var_name + "' already exists with subdomain restriction '" +
                Moose::stringify(var.blocks()) + "' which does not include the subdomains '" +
                Moose::stringify(blocks) + "', required for this Physics.");
 }

◆ solverVariableExists()

bool PhysicsBase::solverVariableExists ( const VariableName & var_name ) const

protectedinherited

Check whether a variable already exists and is a solver variable.

Definition at line 434 of file PhysicsBase.C.

 {
   return _problem->hasSolverVariable(var_name);
 }

◆ solverVariableNames()

const std::vector<VariableName>& PhysicsBase::solverVariableNames ( ) const

inlineinherited

Return the list of solver (nonlinear + linear) variables in this physics.

Definition at line 98 of file PhysicsBase.h.

Referenced by PhysicsBase::act(), PhysicsComponentInterface::addComponent(), and PhysicsBase::initializePhysics().

98 { return _solver_var_names; };

PhysicsBase::_solver_var_names

std::vector< VariableName > _solver_var_names

Vector of the solver variables (nonlinear and linear) in the Physics.

Definition: PhysicsBase.h:319

◆ specificTaskName()

const std::string& Action::specificTaskName ( ) const

inlineinherited

Definition at line 100 of file Action.h.

100 { return _specific_task_name; }

Action::_specific_task_name

std::string _specific_task_name

This member will only be populated if this Action instance is only designed to handle one task...

Definition: Action.h:149

◆ timedAct()

void Action::timedAct ( )

inherited

The method called externally that causes the action to act()

Definition at line 81 of file Action.C.

Referenced by ActionWarehouse::executeActionsWithAction().

 {
   TIME_SECTION(_act_timer);
   act();
 }

◆ timedSectionName()

std::string PerfGraphInterface::timedSectionName ( const std::string & section_name ) const

protectedinherited

Returns: The name of the timed section with the name section_name.

Optionally adds a prefix if one is defined.

Definition at line 47 of file PerfGraphInterface.C.

Referenced by PerfGraphInterface::registerTimedSection().

 {
   return _prefix.empty() ? "" : (_prefix + "::") + section_name;
 }

◆ type()

const std::string& MooseBase::type ( ) const

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 51 of file MooseBase.h.

51 { return _type; }

MooseBase::_type

const std::string _type

The type of this class.

Definition: MooseBase.h:87

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 27 of file MooseBase.C.

Referenced by MaterialPropertyStorage::addProperty(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().

 {
   return type() + std::string(" \"") + name() + std::string("\"");
 }

◆ uniqueActionName()

MooseObjectName Action::uniqueActionName ( ) const

inlineinherited

The unique name for accessing input parameters of this action in the InputParameterWarehouse.

Definition at line 98 of file Action.h.

Referenced by NEML2Action::NEML2Action().

98 { return uniqueName(); }

MooseBaseParameterInterface::uniqueName

MooseObjectName uniqueName() const

The unique name for accessing input parameters of this object in the InputParameterWarehouse.

Definition: MooseBaseParameterInterface.h:67

◆ uniqueName()

MooseObjectName MooseBaseParameterInterface::uniqueName ( ) const

inlineinherited

The unique name for accessing input parameters of this object in the InputParameterWarehouse.

Definition at line 67 of file MooseBaseParameterInterface.h.

Referenced by MooseBaseParameterInterface::connectControllableParams(), and Action::uniqueActionName().

   {
     return MooseObjectName(_pars.get<std::string>("_unique_name"));
   }

◆ uniqueParameterName()

MooseObjectParameterName MooseBaseParameterInterface::uniqueParameterName ( const std::string & parameter_name ) const

inlineinherited

The unique parameter name of a valid parameter of this object for accessing parameter controls.

Definition at line 52 of file MooseBaseParameterInterface.h.

   {
     return MooseObjectParameterName(
         _pars.get<std::string>("_moose_base"), _moose_base.name(), parameter_name);
   }

◆ validParams()

InputParameters DiffusionCG::validParams ( )

static

Definition at line 20 of file DiffusionCG.C.

 {
   InputParameters params = DiffusionPhysicsBase::validParams();
   params.addClassDescription(
       "Discretizes a diffusion equation with the continuous Galerkin finite element method");
   params.addParam<bool>(
       "use_automatic_differentiation",
       true,
       "Whether to use automatic differentiation for all the terms in the equation");
   params.transferParam<MooseEnum>(MooseVariableBase::validParams(), "order", "variable_order");
 
   return params;
 }

◆ variableExists()

bool PhysicsBase::variableExists	(	const VariableName &	var_name,
		bool	error_if_aux
	)		const

protectedinherited

Check whether a variable already exists.

Definition at line 421 of file PhysicsBase.C.

Referenced by PhysicsBase::shouldCreateVariable().

 {
   if (error_if_aux && _problem->getAuxiliarySystem().hasVariable(var_name))
     mooseError("Variable '",
                var_name,
                "' is supposed to be nonlinear for physics '",
                name(),
                "' but it is already defined as auxiliary");
   else
     return _problem->hasVariable(var_name);
 }

◆ warnInconsistent()

void InputParametersChecksUtils< PhysicsBase >::warnInconsistent	(	const InputParameters &	parameters,
		const std::string &	param_name
	)		const

protectedinherited

Emits a warning if two parameters are not equal to each other.

Parameters

other_param	InputParameters object from another object to check the 'param_name' parameter in
param_name	the name of the parameter to check for consistency

Definition at line 549 of file InputParametersChecksUtils.h.

 {
   const bool consistent = parameterConsistent<T>(other_param, param_name);
   if (!consistent)
     forwardMooseWarning("Parameter " + param_name + " is inconsistent between Physics \"" +
                         forwardName() + "\" of type \"" + forwardType() +
                         "\" and the parameter set for \"" +
                         other_param.get<std::string>("_action_name") + "\" of type \"" +
                         other_param.get<std::string>("action_type") + "\"");
 }

Member Data Documentation

◆ _act_timer

PerfID Action::_act_timer

protectedinherited

Timers.

Definition at line 171 of file Action.h.

Referenced by Action::timedAct().

◆ _action_factory

ActionFactory& MooseBaseParameterInterface::_action_factory

protectedinherited

Builds Actions.

Definition at line 179 of file MooseBaseParameterInterface.h.

Referenced by AddActionComponentAction::act(), CreateMeshSetupActionsForComponents::act(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

◆ _all_tasks

std::set<std::string> Action::_all_tasks

protectedinherited

A list of all the tasks that this Action will satisfy.

Note: That this is not populated at construction time. However, all tasks will be added prior to act().

Definition at line 156 of file Action.h.

Referenced by Action::appendTask(), and Action::getAllTasks().

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 84 of file MooseBase.h.

◆ _awh

ActionWarehouse& Action::_awh

protectedinherited

Reference to ActionWarehouse where we store object build by actions.

Definition at line 159 of file Action.h.

Referenced by CheckIntegrityAction::act(), ReadExecutorParamsAction::act(), CreateExecutionerAction::act(), SetupDampersAction::act(), CreateProblemDefaultAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), SetupTimeStepperAction::act(), AddActionComponentAction::act(), CreateMeshSetupActionsForComponents::act(), AddRelationshipManager::act(), AddActionComponentAction::AddActionComponentAction(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), PhysicsBase::getActionComponent(), NEML2Action::getCommonAction(), PhysicsBase::getCoupledPhysics(), ActionComponent::getProblem(), CommonOutputAction::hasConsole(), ComponentPhysicsInterface::physicsExists(), CreateExecutionerAction::setupAutoPreconditioning(), ReadExecutorParamsAction::setupAutoPreconditioning(), CylinderComponent::setupComponent(), and SetupDebugAction::SetupDebugAction().

◆ _blocks

std::vector<SubdomainName> PhysicsBase::_blocks

protectedinherited

Keep track of the subdomains the Physics is defined on.

Definition at line 261 of file PhysicsBase.h.

Referenced by PhysicsBase::addBlocks(), PhysicsBase::addBlocksById(), PhysicsBase::addComponent(), addFEKernels(), DiffusionFV::addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), DiffusionFV::addSolverVariables(), addSolverVariables(), PhysicsBase::blocks(), PhysicsBase::checkBlockRestrictionIdentical(), and PhysicsBase::initializePhysics().

◆ _components_boundary_conditions

std::map<std::string, std::map<std::pair<VariableName, BoundaryName>, std::pair<MooseFunctorName, ComponentBoundaryConditionInterface::BoundaryConditionType> > > PhysicsComponentInterface::_components_boundary_conditions

protectedinherited

Map of components to variables and boundary conditions.

Definition at line 66 of file PhysicsComponentInterface.h.

Referenced by PhysicsComponentInterface::addBoundaryCondition(), addBoundaryConditionsFromComponents(), and PhysicsComponentInterface::addBoundaryConditionsFromComponents().

◆ _components_initial_conditions

std::map<std::string, std::map<VariableName, MooseFunctorName> > PhysicsComponentInterface::_components_initial_conditions

protectedinherited

Map of components to variables and initial conditions.

Definition at line 60 of file PhysicsComponentInterface.h.

Referenced by PhysicsComponentInterface::addInitialCondition(), DiffusionPhysicsBase::addInitialConditions(), DiffusionPhysicsBase::addInitialConditionsFromComponents(), and PhysicsComponentInterface::addInitialConditionsFromComponents().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

An instance of helper class to write streams to the Console objects.

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _current_task

const std::string& Action::_current_task

protectedinherited

The current action (even though we have separate instances for each action)

Definition at line 162 of file Action.h.

Referenced by ElementIDOutputAction::act(), AddFVInterfaceKernelAction::act(), SetupMeshCompleteAction::act(), CheckIntegrityAction::act(), AddDGKernelAction::act(), AddInterfaceKernelAction::act(), CopyNodalVarsAction::act(), AddScalarKernelAction::act(), CheckFVBCAction::act(), AddKernelAction::act(), CreateProblemDefaultAction::act(), AddFVBCAction::act(), SetupMeshAction::act(), AddFVKernelAction::act(), CombineComponentsMeshes::act(), AdaptivityAction::act(), AddDefaultConvergenceAction::act(), AddTimeStepperAction::act(), SetupTimeIntegratorAction::act(), AddActionComponentAction::act(), SetupRecoverFileBaseAction::act(), AddLinearFVBCAction::act(), CreateMeshSetupActionsForComponents::act(), AddLinearFVKernelAction::act(), AddOutputAction::act(), MaterialDerivativeTestAction::act(), SetAdaptivityOptionsAction::act(), CreateDisplacedProblemAction::act(), AddRelationshipManager::act(), BatchMeshGeneratorAction::act(), DisplayGhostingAction::act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), ActionComponent::act(), AddNodalNormalsAction::act(), PhysicsBase::act(), PhysicsComponentInterface::actOnAdditionalTasks(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _dirichlet_boundaries

const std::vector<BoundaryName>& DiffusionPhysicsBase::_dirichlet_boundaries

protectedinherited

Boundaries on which a Dirichlet boundary condition is applied.

Definition at line 40 of file DiffusionPhysicsBase.h.

Referenced by addFEBCs(), and DiffusionFV::addFVBCs().

◆ _displaced_mesh

std::shared_ptr<MooseMesh>& Action::_displaced_mesh

protectedinherited

Definition at line 165 of file Action.h.

Referenced by SetupMeshCompleteAction::act(), SetupMeshAction::act(), and CreateDisplacedProblemAction::act().

◆ _factory

Factory& MooseBaseParameterInterface::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 176 of file MooseBaseParameterInterface.h.

Referenced by ElementIDOutputAction::act(), AutoCheckpointAction::act(), CreateExecutionerAction::act(), PartitionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AdaptivityAction::act(), CombineComponentsMeshes::act(), SetupMeshAction::act(), SetupPredictorAction::act(), SetupTimeStepperAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), SetupPreconditionerAction::act(), SetupResidualDebugAction::act(), CreateDisplacedProblemAction::act(), MaterialDerivativeTestAction::act(), SetAdaptivityOptionsAction::act(), DisplayGhostingAction::act(), AddControlAction::act(), MaterialOutputAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), AddNodalNormalsAction::act(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), Action::addRelationshipManager(), SampledOutput::cloneMesh(), MooseBaseParameterInterface::connectControllableParams(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), ActionComponent::getFactory(), PhysicsBase::getFactory(), MaterialOutputAction::getParams(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _mesh

std::shared_ptr<MooseMesh>& Action::_mesh

protectedinherited

◆ _name

const std::string MooseBase::_name

protectedinherited

The name of this class.

Definition at line 90 of file MooseBase.h.

◆ _neumann_boundaries

const std::vector<BoundaryName>& DiffusionPhysicsBase::_neumann_boundaries

protectedinherited

Boundaries on which a Neumann boundary condition is applied.

Definition at line 38 of file DiffusionPhysicsBase.h.

Referenced by addFEBCs(), and DiffusionFV::addFVBCs().

◆ _pars

const InputParameters& MooseBaseParameterInterface::_pars

protectedinherited

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition at line 173 of file MooseBaseParameterInterface.h.

◆ _pg_moose_app

MooseApp& PerfGraphInterface::_pg_moose_app

protectedinherited

The MooseApp that owns the PerfGraph.

Definition at line 124 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::perfGraph().

◆ _preconditioning

const MooseEnum& PhysicsBase::_preconditioning

protectedinherited

Whether to add a default preconditioning.

The implementation of the default is defined by the derived class

Definition at line 258 of file PhysicsBase.h.

Referenced by DiffusionPhysicsBase::addPreconditioning().

◆ _prefix

const std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 127 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::timedSectionName().

◆ _problem

std::shared_ptr<FEProblemBase>& Action::_problem

protectedinherited

Convenience reference to a problem this action works on.

Definition at line 168 of file Action.h.

Referenced by ElementIDOutputAction::act(), AddBCAction::act(), SetupMeshCompleteAction::act(), AddConstraintAction::act(), AddDiracKernelAction::act(), CheckIntegrityAction::act(), AddTransferAction::act(), AddInitialConditionAction::act(), AddDGKernelAction::act(), AddMaterialAction::act(), AddMultiAppAction::act(), AddDamperAction::act(), AddFVInitialConditionAction::act(), InitProblemAction::act(), AddVectorPostprocessorAction::act(), AddInterfaceKernelAction::act(), CopyNodalVarsAction::act(), AddMarkerAction::act(), CreateExecutionerAction::act(), AddBoundsVectorsAction::act(), AddFunctorMaterialAction::act(), AddNodalKernelAction::act(), SetupDampersAction::act(), AddFVICAction::act(), AddPostprocessorAction::act(), AddScalarKernelAction::act(), AddFVInterfaceKernelAction::act(), AddICAction::act(), AddUserObjectAction::act(), AddIndicatorAction::act(), CheckFVBCAction::act(), AutoCheckpointAction::act(), AddKernelAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), AddFieldSplitAction::act(), AddPositionsAction::act(), AddReporterAction::act(), AddTimesAction::act(), AddFVBCAction::act(), AddFVKernelAction::act(), AdaptivityAction::act(), ComposeTimeStepperAction::act(), AddDistributionAction::act(), DumpObjectsAction::act(), AddMeshDivisionAction::act(), AddConvergenceAction::act(), SetupDebugAction::act(), SetupTimeStepperAction::act(), SetupPreconditionerAction::act(), SetupPredictorAction::act(), AddFunctionAction::act(), SetupTimeIntegratorAction::act(), AddTimeStepperAction::act(), AddHDGKernelAction::act(), ChainControlSetupAction::act(), AddLinearFVKernelAction::act(), AddAuxKernelAction::act(), AddLinearFVBCAction::act(), AddExternalAuxVariableAction::act(), SetupResidualDebugAction::act(), AddOutputAction::act(), MaterialDerivativeTestAction::act(), AddMeshModifiersAction::act(), AddCorrectorAction::act(), SetAdaptivityOptionsAction::act(), CreateDisplacedProblemAction::act(), CouplingFunctorCheckAction::act(), SetMFEMMeshFESpaceAction::act(), AddMFEMProblemOperatorAction::act(), SetupQuadratureAction::act(), AddControlAction::act(), DisplayGhostingAction::act(), AddSamplerAction::act(), MaterialOutputAction::act(), ResolveOptionalMaterialPropertiesAction::act(), AddMFEMSolverAction::act(), AddMFEMSubMeshAction::act(), AddMFEMPreconditionerAction::act(), AddMFEMFESpaceAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), AddNodalNormalsAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), PhysicsBase::addPetscPairsToPetscOptions(), AddVariableAction::addVariable(), AddPeriodicBCAction::autoTranslationBoundaries(), PhysicsBase::checkIntegrityEarly(), CheckOutputAction::checkMaterialOutput(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), CheckOutputAction::checkVariableOutput(), PhysicsBase::getProblem(), AddVariableAction::getSubdomainIDs(), MaterialOutputAction::hasFunctorProperty(), AddVariableAction::init(), PhysicsBase::isTransient(), PhysicsBase::isVariableFV(), PhysicsBase::isVariableScalar(), MaterialOutputAction::outputHelper(), ProjectedStatefulMaterialStorageAction::processProperty(), AddPeriodicBCAction::setPeriodicVars(), CreateExecutionerAction::setupAutoPreconditioning(), PhysicsBase::shouldCreateIC(), PhysicsBase::shouldCreateTimeDerivative(), PhysicsBase::shouldCreateVariable(), PhysicsBase::solverVariableExists(), and PhysicsBase::variableExists().

◆ _registered_identifier

std::string Action::_registered_identifier

protectedinherited

Definition at line 141 of file Action.h.

Referenced by SetupMeshAction::act().

◆ _specific_task_name

std::string Action::_specific_task_name

protectedinherited

This member will only be populated if this Action instance is only designed to handle one task.

This happens when an Action is registered with several pieces of syntax in which case separate instances are built to handle the different incoming parameter values.

Definition at line 149 of file Action.h.

Referenced by Action::specificTaskName().

◆ _system_names

std::vector<SolverSystemName> PhysicsBase::_system_names

protectedinherited

System names for the system(s) owning the solver variables.

Definition at line 248 of file PhysicsBase.h.

Referenced by PhysicsBase::checkIntegrityEarly(), PhysicsBase::getSolverSystem(), and PhysicsBase::initializePhysics().

◆ _system_numbers

std::vector<unsigned int> PhysicsBase::_system_numbers

protectedinherited

System numbers for the system(s) owning the solver variables.

Definition at line 251 of file PhysicsBase.h.

Referenced by PhysicsBase::addPetscPairsToPetscOptions(), PhysicsBase::copyVariablesFromMesh(), and PhysicsBase::initializePhysics().

◆ _type

const std::string MooseBase::_type

protectedinherited

The type of this class.

Definition at line 87 of file MooseBase.h.

Referenced by ExplicitTimeIntegrator::ExplicitTimeIntegrator(), FEProblemSolve::FEProblemSolve(), FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), ExplicitTimeIntegrator::init(), FEProblemBase::init(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), FEProblemBase::solverTypeString(), and MooseBase::type().

◆ _use_ad

const bool DiffusionCG::_use_ad

private

Whether to use automatic differentiation or not.

Definition at line 33 of file DiffusionCG.h.

Referenced by addFEBCs(), and addFEKernels().

◆ _var_name

const VariableName& DiffusionPhysicsBase::_var_name

protectedinherited

Name of the diffused variable.

Definition at line 36 of file DiffusionPhysicsBase.h.

Referenced by addBoundaryConditionsFromComponents(), addFEBCs(), addFEKernels(), DiffusionFV::addFVBCs(), DiffusionFV::addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), DiffusionPhysicsBase::addInitialConditionsFromComponents(), DiffusionPhysicsBase::addPostprocessors(), DiffusionFV::addSolverVariables(), addSolverVariables(), and DiffusionPhysicsBase::DiffusionPhysicsBase().

◆ _verbose

const bool PhysicsBase::_verbose

protectedinherited

Whether to output additional information.

Definition at line 254 of file PhysicsBase.h.

Referenced by PhysicsBase::initializePhysics(), and PhysicsBase::reportPotentiallyMissedParameters().

◆ NAME

constexpr auto MeshMetaDataInterface::NAME = "<empty>"

staticinherited

The data name used when initializing the Restartable interface for non-MeshGenerator objects.

Definition at line 33 of file MeshMetaDataInterface.h.

◆ SYSTEM

constexpr auto MeshMetaDataInterface::SYSTEM = "MeshMetaData"

staticinherited

The system name used when initializing the Restartable interface.

Definition at line 30 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::meshPropertyName().

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

include/physics/DiffusionCG.h
src/physics/DiffusionCG.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Constructor & Destructor Documentation

◆ DiffusionCG()

Member Function Documentation

◆ act()

◆ actOnAdditionalTasks()

◆ addBlocks()

◆ addBlocksById()

◆ addBoundaryCondition()

◆ addBoundaryConditionsFromComponents()

◆ addComponent() [1/2]

◆ addComponent() [2/2]

◆ addFEBCs()

◆ addFEKernels()

◆ addInitialCondition()

◆ addPetscPairsToPetscOptions()

◆ addRelationshipManagers()

◆ addRequiredPhysicsTask()

◆ addSolverVariables()

◆ allMeshBlocks() [1/2]

◆ allMeshBlocks() [2/2]

◆ appendTask()

◆ assertParamDefined() [1/2]

◆ assertParamDefined() [2/2]

◆ assignBlocks()

◆ associateWithParameter() [1/2]

◆ associateWithParameter() [2/2]

◆ auxVariableNames()

◆ blocks()

◆ callMooseError()

◆ checkBlockRestrictionIdentical()

◆ checkBlockwiseConsistency()

◆ checkComponentType()

◆ checkParamsBothSetOrNotSet()

◆ checkSecondParamNotSetIfFirstOneSet()

◆ checkSecondParamSetOnlyIfFirstOneSet()

◆ checkSecondParamSetOnlyIfFirstOneTrue()

◆ checkTwoDVectorParamInnerSameLengthAsOneDVector()

◆ checkTwoDVectorParamMultiMooseEnumSameLength()

◆ checkTwoDVectorParamsNoRespectiveOverlap()

◆ checkTwoDVectorParamsSameLength()

◆ checkVectorParamAndMultiMooseEnumLength()

◆ checkVectorParamLengthSameAsCombinedOthers()

◆ checkVectorParamNotEmpty()

◆ checkVectorParamsNoOverlap()

◆ checkVectorParamsSameLength()

◆ checkVectorParamsSameLengthIfSet()

◆ connectControllableParams()

◆ copyVariablesFromMesh()

◆ dimension()

◆ errorDependentParameter()

◆ errorInconsistentDependentParameter()

◆ errorPrefix()

◆ getActionComponent()

◆ getAdditionalRMParams()

◆ getAllTasks()

◆ getCheckedPointerParam()

◆ getCoupledPhysics() [1/2]

◆ getCoupledPhysics() [2/2]

◆ getDataFileName()

◆ getDataFileNameByName()

◆ getDataFilePath()

◆ getFactory() [1/2]

◆ getFactory() [2/2]

◆ getMeshProperty() [1/2]

◆ getMeshProperty() [2/2]

◆ getMooseApp()

◆ getParam() [1/2]