Creates all the objects needed to solve a diffusion equation with a cell-centered finite volume discretization. More...

#include <DiffusionFV.h>

Inheritance diagram for DiffusionFV:

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

Public Member Functions
	DiffusionFV (const InputParameters &parameters)

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

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

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

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

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

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.

bool	hasBlocks (const std::vector< SubdomainName > &blocks) const
	Whether the Physics is defined on those blocks.

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.

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

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

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

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

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

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

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

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

virtual std::vector< UserObjectName >	getSuppliedUserObjects () const
	Return the names of the UserObjects this Physics adds to the problem.

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

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

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.

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

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

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

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

MooseObjectName	uniqueName () const

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

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

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

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.

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

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

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.

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

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

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.

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.

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.

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const

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.

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const
	Deprecated message prefix; the error type is no longer used.

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

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

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

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

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

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

template<typename... Args>
void	mooseDeprecated (Args &&... args) const
	Emits a deprecation warning prefixed with the object name and type, and a stack trace.

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

template<typename... Args>
void	mooseDeprecatedNoTrace (Args &&... args) const
	Emits a deprecation warning prefixed with the object name and type, and no stack trace.

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
	External method for calling moose error with added object context.

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.

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

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

PerfGraph &	perfGraph ()
	Get the PerfGraph.

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.

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.

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)
	External method for calling moose error with added object context.

Public Attributes
	usingCombinedWarningSolutionWarnings

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

Static Public Attributes
static const std::string	unique_action_name_param = "_unique_action_name"
	The name of the parameter that contains the unique action name.

static const std::string	type_param = "_type"
	The name of the parameter that contains the object type.

static const std::string	name_param = "_object_name"
	The name of the parameter that contains the object name.

static const std::string	unique_name_param = "_unique_name"
	The name of the parameter that contains the unique object name.

static const std::string	app_param = "_moose_app"
	The name of the parameter that contains the MooseApp.

static const std::string	moose_base_param = "_moose_base"
	The name of the parameter that contains the moose system base.

static const std::string	kokkos_object_param = "_kokkos_object"
	The name of the parameter that indicates an object is a Kokkos functor.

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

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

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

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

Factory &	getFactory () const

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

virtual const FEProblemBase &	getProblem () const

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

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

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

void	addUserObject (const std::string &uo_type, const std::string &uo_name, InputParameters &params)
	Add a UserObject supplied by this Physics to the problem.

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

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

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

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

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

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

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.

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.

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

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.

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.

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

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

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

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

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.

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.

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

virtual void	checkIntegrity () const
	Additional checks performed near the end of the setup phase.

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.

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.

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.

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.

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.

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

template<bool warning>
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
	Set solution invalid mark for the given solution ID.

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

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

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

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.

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

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

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

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`)

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.

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.

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.

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.

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.

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

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.

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.

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.

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

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

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.

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.

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.

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

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

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

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

const bool	_verbose
	Whether to output additional information.

const MooseEnum &	_preconditioning
	Whether to add a default preconditioning.

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

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.

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

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

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

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.

PerfID	_act_timer
	Timers.

MooseApp &	_app
	The MOOSE application this is associated with.

Factory &	_factory
	The Factory associated with the MooseApp.

ActionFactory &	_action_factory
	Builds Actions.

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

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

const InputParameters &	_pars
	The object's parameters.

const Parallel::Communicator &	_communicator

MooseApp &	_pg_moose_app
	The MooseApp that owns the PerfGraph.

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

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

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.

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 We keep these private as we don't want a derived class to call a do-nothing implementation If they call a parent class implementation, it must have been re-defined as protected.

virtual void	addFVKernels () override

virtual void	addFVBCs () override

virtual void	initializePhysicsAdditional () override
	Additional initialization work that should happen very early, as soon as the problem is created.

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

virtual void	addPreconditioning () override

virtual void	addPostprocessors () override
	Add postprocessing of the fluxes.

virtual void	addInitialConditions () override

virtual void	addInitialConditionsFromComponents () override

virtual void	addRelationshipManagers (Moose::RelationshipManagerType input_rm_type) override
	Method to add a relationship manager for the objects being added to the system.

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
	Gathers additional parameters for the relationship managers from the Physics then calls the parent Action::addRelationshipManagers with those parameters.

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)
	Gathers additional parameters for the relationship managers from the Physics then calls the parent Action::addRelationshipManagers with those parameters.

void	initializePhysics ()
	Process some parameters that require the problem to be created. Executed on init_physics.

virtual void	checkIntegrityEarly () const
	Additional checks performed once the executioner / executor has been created.

virtual void	addAuxiliaryVariables ()

virtual void	addFEKernels ()

virtual void	addFVInterpolationMethods ()

virtual void	addNodalKernels ()

virtual void	addDiracKernels ()

virtual void	addDGKernels ()

virtual void	addScalarKernels ()

virtual void	addInterfaceKernels ()

virtual void	addFVInterfaceKernels ()

virtual void	addFEBCs ()

virtual void	addNodalBCs ()

virtual void	addPeriodicBCs ()

virtual void	addFunctions ()

virtual void	addAuxiliaryKernels ()

virtual void	addMaterials ()

virtual void	addFunctorMaterials ()

virtual void	addUserObjects ()

virtual void	addCorrectors ()

virtual void	addMultiApps ()

virtual void	addTransfers ()

virtual void	addVectorPostprocessors ()

virtual void	addReporters ()

virtual void	addOutputs ()

virtual void	addExecutioner ()

virtual void	addExecutors ()

void	checkRequiredTasks () const
	Check the list of required tasks for missing tasks.

bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)
	Method for adding a single relationship manager.

virtual std::string	meshPropertyPrefix (const std::string &data_name) const
	The default prefix to use for getting/seeing if mesh properties exist.

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const
	Helper for getting a mesh property.

template<typename... Args>
void	mooseErrorInternal (Args &&... args) const
	Helper for forwarding a mooseError to an object's mooseError if it is available (said error will provide more context: object name and type)

const T &	forwardGetParam (const std::string &param_name) const
	Forwards parameter check to the class using this utility.

const InputParameters &	forwardParameters () const
	Forwards obtaining parameters to the class using this utility.

bool	forwardIsParamSetByUser (const std::string &param_name) const
	Forwards parameter check to the class using this utility.

bool	forwardIsParamValid (const std::string &param_name) const
	Forwards parameter check to the class using this utility.

void	forwardParamError (Args &&... args) const
	Forwards error to the class using this utility to get better error messages.

void	forwardMooseError (Args &&... args) const
	Forwards error to the class using this utility to get better error messages.

void	forwardMooseWarning (Args &&... args) const
	Forwards warning to the class using this utility to get better error messages.

const std::string &	forwardType () const
	Get the type of the class using this utility.

virtual const std::string &	forwardName () const
	Get the name of the class using this utility.

const std::vector< SubdomainName > &	forwardBlocks () const
	Get the blocks for the class using this utility.

virtual void	addBoundaryConditionsFromComponents ()

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)
	Internal method for getting a hit node (if available) given a set of parameters.

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)
	Internal method for getting the message prefix for an object (object type, name, etc).

Private Attributes
MooseEnum	_is_transient
	Whether the physics is to be solved as a transient.

std::vector< VariableName >	_solver_var_names
	Vector of the solver variables (nonlinear and linear) in the Physics.

std::vector< VariableName >	_aux_var_names
	Vector of the aux variables in the Physics.

unsigned int	_dim = libMesh::invalid_uint
	Dimension of the physics, which we expect for now to be the dimension of the mesh NOTE: this is not known at construction time, only after initializePhysics which is a huge bummer.

std::set< std::string >	_required_tasks
	Manually keeps track of the tasks required by each physics as tasks cannot be inherited.

const ParallelParamObject &	_parent

MooseApp &	_meta_data_app
	Reference to the application.

const MooseObject *const	_meta_data_object
	The MooseObject (if any); used for better error handling.

const MooseBase &	_si_moose_base
	The MooseBase that owns this interface.

const FEProblemBase *	_si_problem
	A pointer to FEProblem base.

const PhysicsBase *const	_customer_class

Detailed Description

Creates all the objects needed to solve a diffusion equation with a cell-centered finite volume discretization.

Definition at line 18 of file DiffusionFV.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

◆ DiffusionFV()

DiffusionFV::DiffusionFV ( const InputParameters & parameters )

Definition at line 35 of file DiffusionFV.C.

  : PhysicsBase(parameters), PhysicsComponentInterface(parameters), DiffusionPhysicsBase(parameters)
{
}

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 124 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" || _current_task == "add_variables_physics") &&
           !getParam<bool>("dont_create_solver_variables"))
    addSolverVariables();
  else if ((_current_task == "add_ic" || _current_task == "add_fv_ic" ||
            _current_task == "add_ics_physics") &&
           !getParam<bool>("dont_create_ics"))
    addInitialConditions();
 
  // Kernels
  else if (_current_task == "add_interpolation_method_physics" &&
           !getParam<bool>("dont_create_kernels"))
    addFVInterpolationMethods();
  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" || _current_task == "add_materials_physics") &&
           !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.

49{}

Referenced by PhysicsBase::act().

◆ addAuxiliaryKernels()

virtual void PhysicsBase::addAuxiliaryKernels ( )

inlineprivatevirtualinherited

Definition at line 331 of file PhysicsBase.h.

331{}

Referenced by PhysicsBase::act().

◆ addAuxiliaryVariables()

virtual void PhysicsBase::addAuxiliaryVariables ( )

inlineprivatevirtualinherited

Definition at line 315 of file PhysicsBase.h.

315{}

Referenced by PhysicsBase::act().

◆ 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 310 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 320 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 89 of file PhysicsComponentInterface.C.

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

Referenced by PhysicsComponentInterface::addComponent().

◆ addBoundaryConditionsFromComponents()

void PhysicsComponentInterface::addBoundaryConditionsFromComponents ( )

privatevirtualinherited

Reimplemented in DiffusionCG.

Definition at line 117 of file PhysicsComponentInterface.C.

{
  if (_components_boundary_conditions.size())
  {
    std::vector<ComponentName> all_components(_components_boundary_conditions.size());
    for (const auto & comp : _components_boundary_conditions)
      all_components.push_back(comp.first);
    mooseError("Component(s) '",
               Moose::stringify(all_components),
               "' requested to add boundary conditions for the variable of this Physics. This "
               "Physics however does not implement the 'addBoundaryConditionsFromComponents' "
               "routine, so it cannot create these boundary conditions");
  }
}

Referenced by PhysicsComponentInterface::actOnAdditionalTasks().

◆ addComponent() [1/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 331 of file PhysicsBase.C.

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

Referenced by PhysicsComponentInterface::addComponent().

◆ addComponent() [2/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 40 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);
        }
  }
}

◆ addCorrectors()

virtual void PhysicsBase::addCorrectors ( )

inlineprivatevirtualinherited

Definition at line 335 of file PhysicsBase.h.

335{}

Referenced by PhysicsBase::act().

◆ addDGKernels()

virtual void PhysicsBase::addDGKernels ( )

inlineprivatevirtualinherited

Definition at line 322 of file PhysicsBase.h.

322{}

Referenced by PhysicsBase::act().

◆ addDiracKernels()

virtual void PhysicsBase::addDiracKernels ( )

inlineprivatevirtualinherited

Definition at line 321 of file PhysicsBase.h.

321{}

Referenced by PhysicsBase::act().

◆ addExecutioner()

virtual void PhysicsBase::addExecutioner ( )

inlineprivatevirtualinherited

Definition at line 343 of file PhysicsBase.h.

343{}

Referenced by PhysicsBase::act().

◆ addExecutors()

virtual void PhysicsBase::addExecutors ( )

inlineprivatevirtualinherited

Definition at line 344 of file PhysicsBase.h.

344{}

Referenced by PhysicsBase::act().

◆ addFEBCs()

virtual void PhysicsBase::addFEBCs ( )

inlineprivatevirtualinherited

Reimplemented in DiffusionCG.

Definition at line 326 of file PhysicsBase.h.

326{}

Referenced by PhysicsBase::act().

◆ addFEKernels()

virtual void PhysicsBase::addFEKernels ( )

inlineprivatevirtualinherited

Reimplemented in DiffusionCG.

Definition at line 317 of file PhysicsBase.h.

317{}

Referenced by PhysicsBase::act().

◆ addFunctions()

virtual void PhysicsBase::addFunctions ( )

inlineprivatevirtualinherited

Definition at line 330 of file PhysicsBase.h.

330{}

Referenced by PhysicsBase::act().

◆ addFunctorMaterials()

virtual void PhysicsBase::addFunctorMaterials ( )

inlineprivatevirtualinherited

Definition at line 333 of file PhysicsBase.h.

333{}

Referenced by PhysicsBase::act().

◆ addFVBCs()

void DiffusionFV::addFVBCs ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 114 of file DiffusionFV.C.

{
  if (isParamValid("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
      std::string bc_type = "";
      if (MooseUtils::parsesToReal(bc_flux))
        bc_type = "FVNeumannBC";
      else if (getProblem().hasFunction(bc_flux))
        bc_type = "FVFunctionNeumannBC";
      else
        bc_type = "FVFunctorNeumannBC";
 
      InputParameters params = getFactory().getValidParams(bc_type);
      params.set<NonlinearVariableName>("variable") = _var_name;
      params.set<std::vector<BoundaryName>>("boundary") = {_neumann_boundaries[i]};
 
      // Set the boundary condition parameter for the specific boundary condition type used
      if (MooseUtils::parsesToReal(bc_flux))
        params.set<Real>("value") = MooseUtils::convert<Real>(bc_flux);
      else if (getProblem().hasFunction(bc_flux))
        params.set<FunctionName>("function") = bc_flux;
      else
        params.set<MooseFunctorName>("functor") = bc_flux;
 
      getProblem().addFVBC(
          bc_type, prefix() + _var_name + "_neumann_bc_" + _neumann_boundaries[i], params);
    }
  }
 
  if (isParamValid("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 = "FVDirichletBC";
      else if (getProblem().hasFunction(bc_value))
        bc_type = "FVFunctionDirichletBC";
      else
        bc_type = "FVADFunctorDirichletBC";
 
      InputParameters params = getFactory().getValidParams(bc_type);
      params.set<NonlinearVariableName>("variable") = _var_name;
      params.set<std::vector<BoundaryName>>("boundary") = {_dirichlet_boundaries[i]};
 
      // Set the boundary condition parameter for the specific boundary condition type used
      if (MooseUtils::parsesToReal(bc_value))
        params.set<Real>("value") = MooseUtils::convert<Real>(bc_value);
      else if (getProblem().hasFunction(bc_value))
        params.set<FunctionName>("function") = bc_value;
      else
        params.set<MooseFunctorName>("functor") = bc_value;
 
      getProblem().addFVBC(
          bc_type, prefix() + _var_name + "_dirichlet_bc_" + _dirichlet_boundaries[i], params);
    }
  }
}

◆ addFVInterfaceKernels()

virtual void PhysicsBase::addFVInterfaceKernels ( )

inlineprivatevirtualinherited

Definition at line 325 of file PhysicsBase.h.

325{}

Referenced by PhysicsBase::act().

◆ addFVInterpolationMethods()

virtual void PhysicsBase::addFVInterpolationMethods ( )

inlineprivatevirtualinherited

Definition at line 319 of file PhysicsBase.h.

319{}

Referenced by PhysicsBase::act().

◆ addFVKernels()

void DiffusionFV::addFVKernels ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 47 of file DiffusionFV.C.

{
  // Diffusion term
  {
    const std::string kernel_type = "FVDiffusion";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
    params.set<NonlinearVariableName>("variable") = _var_name;
    params.set<MooseFunctorName>("coeff") = getParam<MooseFunctorName>("diffusivity_functor");
    getProblem().addFVKernel(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 = "FVBodyForce";
    else if (getProblem().hasVariable(source))
      kernel_type = "FVCoupledForce";
    else
      paramError("source_functor",
                 "No kernel defined for a source term in FV for the type used for '",
                 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<MooseFunctorName>("v") = {source};
    }
 
    getProblem().addFVKernel(kernel_type, prefix() + _var_name + "_source", params);
  }
  // Time derivative
  if (shouldCreateTimeDerivative(_var_name, _blocks, false))
  {
    const std::string kernel_type = "FVTimeKernel";
    InputParameters params = getFactory().getValidParams(kernel_type);
    params.set<NonlinearVariableName>("variable") = _var_name;
    assignBlocks(params, _blocks);
    getProblem().addFVKernel(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 81 of file PhysicsComponentInterface.C.

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

Referenced by PhysicsComponentInterface::addComponent().

◆ addInitialConditions()

void DiffusionPhysicsBase::addInitialConditions ( )

overrideprivatevirtualinherited

Reimplemented from PhysicsBase.

Definition at line 129 of file DiffusionPhysicsBase.C.

{
  InputParameters params = getFactory().getValidParams("FunctionIC");
 
  // Get the list of blocks that have ics from components
  std::vector<SubdomainName> component_ic_blocks;
  for (const auto & [component_name, component_bc_map] : _components_initial_conditions)
  {
    if (!component_bc_map.count(_var_name))
      continue;
    const auto & comp_blocks = getActionComponent(component_name).blocks();
    component_ic_blocks.insert(component_ic_blocks.end(), comp_blocks.begin(), comp_blocks.end());
  }
 
  // Keep only blocks that have no component IC
  std::vector<SubdomainName> remaining_blocks;
  for (const auto & block : _blocks)
    if (std::find(component_ic_blocks.begin(), component_ic_blocks.end(), block) ==
        component_ic_blocks.end())
      remaining_blocks.push_back(block);
 
  // No need to add BCs on the Physics block restriction if Components are covering all of it
  if (remaining_blocks.empty())
    return;
  assignBlocks(params, remaining_blocks);
 
  // first obey any component-specific initial condition
  // then obey the user specification of initial conditions
  // NOTE: we may conflict with ICs in the input
  // there are no default initial conditions
  mooseAssert(parameters().isParamSetByUser("initial_condition") ||
                  !parameters().hasDefault("initial_condition"),
              "Should not have a default");
  if (isParamValid("initial_condition") &&
      shouldCreateIC(
          _var_name, remaining_blocks, /*ic is a default*/ false, /*error if defined*/ true))
  {
    params.set<VariableName>("variable") = _var_name;
    params.set<FunctionName>("function") = getParam<FunctionName>("initial_condition");
 
    getProblem().addInitialCondition("FunctionIC", prefix() + _var_name + "_ic", params);
  }
}

◆ addInitialConditionsFromComponents()

void DiffusionPhysicsBase::addInitialConditionsFromComponents ( )

overrideprivatevirtualinherited

Reimplemented from PhysicsComponentInterface.

Definition at line 174 of file DiffusionPhysicsBase.C.

{
  InputParameters params = getFactory().getValidParams("FunctorIC");
 
  // ICs from components are considered always set by the user, so we do not skip them when
  // restarting
  for (const auto & [component_name, component_bc_map] : _components_initial_conditions)
  {
    if (!component_bc_map.count(_var_name))
      continue;
    assignBlocks(params, getActionComponent(component_name).blocks());
    params.set<VariableName>("variable") = _var_name;
    params.set<MooseFunctorName>("functor") = libmesh_map_find(component_bc_map, _var_name);
 
    getProblem().addInitialCondition(
        "FunctorIC", prefix() + _var_name + "_ic_" + component_name, params);
  }
}

◆ addInterfaceKernels()

virtual void PhysicsBase::addInterfaceKernels ( )

inlineprivatevirtualinherited

Definition at line 324 of file PhysicsBase.h.

324{}

Referenced by PhysicsBase::act().

◆ addMaterials()

virtual void PhysicsBase::addMaterials ( )

inlineprivatevirtualinherited

Definition at line 332 of file PhysicsBase.h.

332{}

Referenced by PhysicsBase::act().

◆ addMultiApps()

virtual void PhysicsBase::addMultiApps ( )

inlineprivatevirtualinherited

Definition at line 336 of file PhysicsBase.h.

336{}

Referenced by PhysicsBase::act().

◆ addNodalBCs()

virtual void PhysicsBase::addNodalBCs ( )

inlineprivatevirtualinherited

Definition at line 328 of file PhysicsBase.h.

328{}

Referenced by PhysicsBase::act().

◆ addNodalKernels()

virtual void PhysicsBase::addNodalKernels ( )

inlineprivatevirtualinherited

Definition at line 320 of file PhysicsBase.h.

320{}

Referenced by PhysicsBase::act().

◆ addOutputs()

virtual void PhysicsBase::addOutputs ( )

inlineprivatevirtualinherited

Definition at line 341 of file PhysicsBase.h.

341{}

Referenced by PhysicsBase::act().

◆ addPeriodicBCs()

virtual void PhysicsBase::addPeriodicBCs ( )

inlineprivatevirtualinherited

Definition at line 329 of file PhysicsBase.h.

329{}

Referenced by PhysicsBase::act().

◆ 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 612 of file PhysicsBase.C.

{
  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);
}

Referenced by DiffusionPhysicsBase::addPreconditioning().

◆ addPostprocessors()

void DiffusionPhysicsBase::addPostprocessors ( )

overrideprivatevirtualinherited

Add postprocessing of the fluxes.

Reimplemented from PhysicsBase.

Definition at line 99 of file DiffusionPhysicsBase.C.

{
  for (const auto & boundary_name :
       getParam<std::vector<BoundaryName>>("compute_diffusive_fluxes_on"))
  {
    // Create the boundary integration of the flux
    const bool use_ad = isParamValid("use_automatic_differentiation")
                            ? getParam<bool>("use_automatic_differentiation")
                            : false;
    const std::string pp_type =
        use_ad ? "ADSideDiffusiveFluxIntegral" : "SideDiffusiveFluxIntegral";
    auto params = _factory.getValidParams(pp_type);
    params.set<std::vector<VariableName>>("variable") = {_var_name};
    if (isParamValid("diffusivity_matprop"))
      params.set<MaterialPropertyName>("diffusivity") =
          getParam<MaterialPropertyName>("diffusivity_matprop");
    else if (isParamValid("diffusivity_functor"))
      params.set<MooseFunctorName>("functor_diffusivity") =
          getParam<MooseFunctorName>("diffusivity_functor");
    else
      params.set<MooseFunctorName>("functor_diffusivity") = "1";
    params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
    // Default to maximum computation
    params.set<ExecFlagEnum>("execute_on") = {
        EXEC_INITIAL, EXEC_TIMESTEP_END, EXEC_NONLINEAR, EXEC_LINEAR};
    getProblem().addPostprocessor(pp_type, prefix() + "diffusive_flux_" + boundary_name, params);
  }
}

◆ addPreconditioning()

void DiffusionPhysicsBase::addPreconditioning ( )

overrideprivatevirtualinherited

Reimplemented from PhysicsBase.

Definition at line 84 of file DiffusionPhysicsBase.C.

{
  // Use a multigrid method, known to work for elliptic problems such as diffusion
  if (_preconditioning == "default")
  {
    // We only pass petsc options as that's all that's needed to set up the preconditioner
    const auto option_pair1 =
        std::make_pair<MooseEnumItem, std::string>(MooseEnumItem("-pc_type"), "hypre");
    const auto option_pair2 =
        std::make_pair<MooseEnumItem, std::string>(MooseEnumItem("-pc_hypre_type"), "boomeramg");
    addPetscPairsToPetscOptions({option_pair1, option_pair2});
  }
}

◆ addRelationshipManager()

bool Action::addRelationshipManager	(	Moose::RelationshipManagerType	input_rm_type,
		const InputParameters &	moose_object_pars,
		std::string	rm_name,
		Moose::RelationshipManagerType	rm_type,
		Moose::RelationshipManagerInputParameterCallback	rm_input_parameter_func,
		Moose::RMSystemType	sys_type = `Moose::RMSystemType::NONE`
	)

privateinherited

Method for adding a single relationship manager.

Parameters

input_rm_type	What relationship manager type we are currently adding
moose_object_pars	The parameters of the MooseObject that requested the RM
rm_name	The class type of the RM, e.g. ElementSideNeighborLayers
rm_type	The RelationshipManagerType, e.g. geometric, algebraic, coupling
rm_input_parameter_func	The RM callback function, typically a lambda defined in the requesting MooseObject's validParams function
sys_type	A RMSystemType that can be used to limit the systems and consequent dof_maps that the RM can be attached to

Returns: Whether a relationship manager was added

Definition at line 100 of file Action.C.

{
  // These need unique names
  static unsigned int unique_object_id = 0;
 
  auto new_name = moose_object_pars.getBase() + '_' + name() + '_' + rm_name + "_" +
                  Moose::stringify(rm_type) + " " + std::to_string(unique_object_id);
 
  auto rm_params = _factory.getValidParams(rm_name);
  rm_params.set<Moose::RelationshipManagerType>("rm_type") = rm_type;
 
  rm_params.set<std::string>("for_whom") = name();
 
  // If there is a callback for setting the RM parameters let's use it
  if (rm_input_parameter_func)
    rm_input_parameter_func(moose_object_pars, rm_params);
 
  rm_params.set<MooseMesh *>("mesh") = _mesh.get();
 
  if (!rm_params.areAllRequiredParamsValid())
    mooseError("Missing required parameters for RelationshipManager " + rm_name + " for object " +
               name());
 
  auto rm_obj = _factory.create<RelationshipManager>(rm_name, new_name, rm_params);
 
  const bool added = _app.addRelationshipManager(rm_obj);
 
  // Delete the resources created on behalf of the RM if it ends up not being added to the App.
  if (!added)
    _factory.releaseSharedObjects(*rm_obj);
  else // we added it
    unique_object_id++;
 
  return added;
}

Referenced by Action::addRelationshipManagers().

◆ addRelationshipManagers() [1/3]

void PhysicsBase::addRelationshipManagers ( Moose::RelationshipManagerType when_type )

overrideprivatevirtualinherited

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.

Reimplemented from Action.

Definition at line 338 of file PhysicsBase.C.

{
  InputParameters params = getAdditionalRMParams();
  Action::addRelationshipManagers(input_rm_type, params);
}

◆ addRelationshipManagers() [2/3]

void Action::addRelationshipManagers ( Moose::RelationshipManagerType when_type )

privatevirtualinherited

Gathers additional parameters for the relationship managers from the Physics then calls the parent Action::addRelationshipManagers with those parameters.

Reimplemented from Action.

Definition at line 103 of file Action.C.

144{

145}

◆ addRelationshipManagers() [3/3]

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

privateinherited

Gathers additional parameters for the relationship managers from the Physics then calls the parent Action::addRelationshipManagers with those parameters.

Definition at line 90 of file Action.C.

{
  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;
}

◆ addReporters()

virtual void PhysicsBase::addReporters ( )

inlineprivatevirtualinherited

Definition at line 340 of file PhysicsBase.h.

340{}

Referenced by PhysicsBase::act().

◆ 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 186 of file PhysicsBase.h.

186{ _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:363

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

◆ addScalarKernels()

virtual void PhysicsBase::addScalarKernels ( )

inlineprivatevirtualinherited

Definition at line 323 of file PhysicsBase.h.

323{}

Referenced by PhysicsBase::act().

◆ addSolverVariables()

void DiffusionFV::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 We keep these private as we don't want a derived class to call a do-nothing implementation If they call a parent class implementation, it must have been re-defined as protected.

Reimplemented from PhysicsBase.

Definition at line 182 of file DiffusionFV.C.

{
  if (!shouldCreateVariable(_var_name, _blocks, true))
  {
    reportPotentiallyMissedParameters({"system_names"}, "MooseVariableFVReal");
    return;
  }
 
  const std::string variable_type = "MooseVariableFVReal";
  InputParameters params = getFactory().getValidParams(variable_type);
  assignBlocks(params, _blocks);
  params.set<SolverSystemName>("solver_sys") = getSolverSystem(_var_name);
  getProblem().addVariable(variable_type, _var_name, params);
}

◆ addTransfers()

virtual void PhysicsBase::addTransfers ( )

inlineprivatevirtualinherited

Definition at line 337 of file PhysicsBase.h.

337{}

Referenced by PhysicsBase::act().

◆ addUserObject()

void PhysicsBase::addUserObject	(	const std::string &	uo_type,
		const std::string &	uo_name,
		InputParameters &	params
	)

protectedinherited

Add a UserObject supplied by this Physics to the problem.

Forwards to FEProblemBase::addUserObject. Use this instead of getProblem().addUserObject() so that any UserObject this Physics supplies is (in a debug build) checked to have been declared in getSuppliedUserObjects(), keeping the declaration and the construction consistent.

Definition at line 233 of file PhysicsBase.C.

{
  mooseAssert(
      [&]()
      {
        const auto supplied = getSuppliedUserObjects();
        return std::find(supplied.begin(), supplied.end(), uo_name) != supplied.end();
      }(),
      "The UserObject '" + uo_name + "' added by Physics '" + name() +
          "' was not declared in getSuppliedUserObjects(). Declare it there so its construction "
          "order can be resolved.");
  getProblem().addUserObject(uo_type, uo_name, params);
}

◆ addUserObjects()

virtual void PhysicsBase::addUserObjects ( )

inlineprivatevirtualinherited

Definition at line 334 of file PhysicsBase.h.

334{}

Referenced by PhysicsBase::act().

◆ addVectorPostprocessors()

virtual void PhysicsBase::addVectorPostprocessors ( )

inlineprivatevirtualinherited

Definition at line 339 of file PhysicsBase.h.

339{}

Referenced by PhysicsBase::act().

◆ allMeshBlocks() [1/2]

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

protectedinherited

Definition at line 605 of file PhysicsBase.C.

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

◆ allMeshBlocks() [2/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 581 of file PhysicsBase.C.

{
  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;
}

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

◆ appendTask()

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

inlineinherited

Definition at line 114 of file Action.h.

114{ _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:166

◆ assertParamDefined() [1/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.");
}

◆ assertParamDefined() [2/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

◆ 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 511 of file PhysicsBase.C.

{
  // 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?");
}

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

◆ associateWithParameter() [1/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 176 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, {});
  }
}

◆ associateWithParameter() [2/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 170 of file Action.C.

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

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

◆ auxVariableNames()

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

inlineinherited

Return the list of aux variables in this physics.

Definition at line 106 of file PhysicsBase.h.

106{ return _aux_var_names; };

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

◆ 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.

60{ return _blocks; }

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

◆ callMooseError() [1/2]

void MooseBase::callMooseError	(	MooseApp *const	app,
		const InputParameters &	params,
		std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node,
		const bool	show_trace = `true`
	)

staticinherited

External method for calling moose error with added object context.

Needed so that objects without the MooseBase context (InputParameters) can call errors with context

Parameters

app	The app pointer (if available); adds multiapp context and clears the console
params	The parameters, needed to obtain object information
msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix
show_trace	Whether or not to show a stack trace, defaults to true

Definition at line 114 of file MooseBase.C.

{
  if (!node)
    node = MooseBase::getHitNode(params);
 
  std::string multiapp_prefix = "";
  if (app)
  {
    if (!app->isUltimateMaster())
      multiapp_prefix = app->name();
    app->getOutputWarehouse().mooseConsole();
  }
 
  if (with_prefix)
    // False here because the hit context will get processed by the node
    msg = messagePrefix(params, false) + msg;
 
  moose::internal::mooseErrorRaw(msg, multiapp_prefix, node, show_trace);
}

◆ callMooseError() [2/2]

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node = `nullptr`,
		const bool	show_trace = `true`
	)		const

inherited

External method for calling moose error with added object context.

Parameters

msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix
show_trace	Whether or not to show a stack trace, defaults to true

Definition at line 105 of file MooseBase.C.

{
  callMooseError(&_app, _pars, msg, with_prefix, node, show_trace);
}

Referenced by MooseBase::callMooseError(), InputParameters::callMooseError(), MooseBase::mooseDocumentedError(), MooseBase::mooseError(), and MooseBase::mooseErrorNonPrefixed().

◆ 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 524 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 120 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 405 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() +
               "'");
}

◆ checkIntegrity()

virtual void PhysicsBase::checkIntegrity ( ) const

inlineprotectedvirtualinherited

Additional checks performed near the end of the setup phase.

Definition at line 279 of file PhysicsBase.h.

279{}

Referenced by PhysicsBase::act().

◆ checkIntegrityEarly()

void PhysicsBase::checkIntegrityEarly ( ) const

privatevirtualinherited

Additional checks performed once the executioner / executor has been created.

Definition at line 398 of file PhysicsBase.C.

{
  if (_is_transient == "true" && !getProblem().isTransient())
    paramError("transient", "We cannot solve a physics as transient in a steady problem");
 
  // Check that there is a system for each variable
  if (_system_names.size() != 1 && _system_names.size() != _solver_var_names.size())
    paramError("system_names",
               "There should be one system name per solver variable (potentially repeated), or a "
               "single system name for all variables. Currently you have '" +
                   std::to_string(_system_names.size()) + "' systems specified for '" +
                   std::to_string(_solver_var_names.size()) + "' solver variables.");
 
  // Check that each variable is present in the expected system
  unsigned int var_i = 0;
  for (const auto & var_name : _solver_var_names)
  {
    const auto & sys_name = _system_names.size() == 1 ? _system_names[0] : _system_names[var_i++];
    if (!_problem->getSolverSystem(_problem->solverSysNum(sys_name)).hasVariable(var_name) &&
        !_problem->getSolverSystem(_problem->solverSysNum(sys_name)).hasScalarVariable(var_name))
      paramError("system_names",
                 "We expected system '" + sys_name + "' to contain variable '" + var_name +
                     "' but it did not. Make sure the system names closely match the ordering of "
                     "the variables in the Physics.");
  }
}

Referenced by PhysicsBase::act().

◆ 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 40 of file InputParametersChecksUtils.h.

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

◆ checkRequiredTasks()

void PhysicsBase::checkRequiredTasks ( ) const

privateinherited

Check the list of required tasks for missing tasks.

Definition at line 495 of file PhysicsBase.C.

{
  const auto registered_tasks = _action_factory.getTasksByAction(type());
 
  // Check for missing tasks
  for (const auto & required_task : _required_tasks)
    if (!registered_tasks.count(required_task))
      mooseWarning("Task '" + required_task +
                   "' has been declared as required by a Physics parent class of derived class '" +
                   type() +
                   "' but this task is not registered to the derived class. Registered tasks for "
                   "this Physics are: " +
                   Moose::stringify(registered_tasks));
}

Referenced by PhysicsBase::act().

◆ 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 54 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 49 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 44 of file InputParametersChecksUtils.h.

{
  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 87 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 93 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 82 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 71 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<S>>(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 65 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 112 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 99 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 77 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 60 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<S>>(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 104 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 MooseBase::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 77 of file MooseBase.C.

{
  auto & factory = _app.getFactory();
  auto & ip_warehouse = _app.getInputParameterWarehouse();
 
  MooseObjectParameterName primary_name(uniqueName(), parameter);
  const auto base_type = factory.getValidParams(object_type).getBase();
  MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
  ip_warehouse.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, name(), parameter);
      ip_warehouse.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 426 of file PhysicsBase.C.

{
  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"));
    }
  }
}

Referenced by PhysicsBase::act().

◆ dimension()

unsigned int PhysicsBase::dimension ( ) const

inherited

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

Definition at line 272 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 137 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 144 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 & ) const

inlineinherited

Deprecated message prefix; the error type is no longer used.

Definition at line 264 of file MooseBase.h.

264{ return messagePrefix(); }

◆ flagInvalidSolutionInternal()

template<bool warning>

template void SolutionInvalidInterface::flagInvalidSolutionInternal< false > ( const InvalidSolutionID invalid_solution_id ) const

protectedinherited

Set solution invalid mark for the given solution ID.

Definition at line 41 of file SolutionInvalidInterface.C.

{
  mooseAssert(
      warning == moose::internal::getSolutionInvalidityRegistry().item(invalid_solution_id).warning,
      "Inconsistent warning flag");
  auto & solution_invalidity = _si_moose_base.getMooseApp().solutionInvalidity();
  if constexpr (!warning)
    if (!_si_problem || _si_problem->immediatelyPrintInvalidSolution())
      solution_invalidity.printDebug(invalid_solution_id);
  return solution_invalidity.flagInvalidSolutionInternal(invalid_solution_id);
}

◆ forwardBlocks()

const std::vector< SubdomainName > & InputParametersChecksUtils< PhysicsBase >::forwardBlocks ( ) const

inlineprivateinherited

Get the blocks for the class using this utility.

Definition at line 192 of file InputParametersChecksUtils.h.

  {
    // TODO Use SFINAE to create a version for classes that do not define blocks()
    // TODO Use SFINAE to force blocks() to return a reference as well
    return _customer_class->blocks();
  }

◆ forwardGetParam()

const T & InputParametersChecksUtils< PhysicsBase >::forwardGetParam ( const std::string & param_name ) const

inlineprivateinherited

Forwards parameter check to the class using this utility.

Definition at line 153 of file InputParametersChecksUtils.h.

  {
    return _customer_class->template getParam<T>(param_name);
  }

◆ forwardIsParamSetByUser()

bool InputParametersChecksUtils< PhysicsBase >::forwardIsParamSetByUser ( const std::string & param_name ) const

inlineprivateinherited

Forwards parameter check to the class using this utility.

Definition at line 160 of file InputParametersChecksUtils.h.

  {
    return _customer_class->isParamSetByUser(param_name);
  }

◆ forwardIsParamValid()

bool InputParametersChecksUtils< PhysicsBase >::forwardIsParamValid ( const std::string & param_name ) const

inlineprivateinherited

Forwards parameter check to the class using this utility.

Definition at line 165 of file InputParametersChecksUtils.h.

  {
    return _customer_class->isParamValid(param_name);
  }

◆ forwardMooseError()

void InputParametersChecksUtils< PhysicsBase >::forwardMooseError ( Args &&... args ) const

inlineprivateinherited

Forwards error to the class using this utility to get better error messages.

Definition at line 177 of file InputParametersChecksUtils.h.

  {
    _customer_class->mooseError(std::forward<Args>(args)...);
  }

◆ forwardMooseWarning()

void InputParametersChecksUtils< PhysicsBase >::forwardMooseWarning ( Args &&... args ) const

inlineprivateinherited

Forwards warning to the class using this utility to get better error messages.

Definition at line 183 of file InputParametersChecksUtils.h.

  {
    _customer_class->mooseWarning(std::forward<Args>(args)...);
  }

◆ forwardName()

virtual const std::string & InputParametersChecksUtils< PhysicsBase >::forwardName ( ) const

inlineprivatevirtualinherited

Get the name of the class using this utility.

Definition at line 190 of file InputParametersChecksUtils.h.

190{ return _customer_class->name(); }

◆ forwardParamError()

void InputParametersChecksUtils< PhysicsBase >::forwardParamError ( Args &&... args ) const

inlineprivateinherited

Forwards error to the class using this utility to get better error messages.

Definition at line 171 of file InputParametersChecksUtils.h.

  {
    _customer_class->paramError(std::forward<Args>(args)...);
  }

◆ forwardParameters()

const InputParameters & InputParametersChecksUtils< PhysicsBase >::forwardParameters ( ) const

inlineprivateinherited

Forwards obtaining parameters to the class using this utility.

Definition at line 158 of file InputParametersChecksUtils.h.

158{ return _customer_class->parameters(); }

◆ forwardType()

const std::string & InputParametersChecksUtils< PhysicsBase >::forwardType ( ) const

inlineprivateinherited

Get the type of the class using this utility.

Definition at line 188 of file InputParametersChecksUtils.h.

188{ return _customer_class->type(); }

◆ getActionComponent()

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

inherited

Get a component with the requested name.

Definition at line 345 of file PhysicsBase.C.

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

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

◆ getAdditionalRMParams()

InputParameters DiffusionFV::getAdditionalRMParams ( ) const

overrideprivatevirtual

Provide additional parameters for the relationship managers.

Reimplemented from PhysicsBase.

Definition at line 198 of file DiffusionFV.C.

{
  const auto necessary_layers =
      std::max(getParam<unsigned short>("ghost_layers"), (unsigned short)2);
 
  // Just an object that has a ghost_layers parameter
  const std::string kernel_type = "FVDiffusion";
  InputParameters params = getFactory().getValidParams(kernel_type);
  params.template set<unsigned short>("ghost_layers") = necessary_layers;
 
  return params;
}

◆ getAllTasks()

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

inlineinherited

Definition at line 112 of file Action.h.

112{ return _all_tasks; }

Referenced by AddKernelAction::act().

◆ getBase()

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

inlineinherited

Returns: The registered base for this object (set via InputParameters::registerBase())

Definition at line 147 of file MooseBase.h.

147{ return _pars.getBase(); }

Referenced by Factory::copyConstruct(), and MooseBase::uniqueParameterName().

◆ getCheckedPointerParam()

template<typename T >

T MooseBase::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 450 of file MooseBase.h.

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

◆ getCoupledPhysics() [1/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 391 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;
}

◆ getCoupledPhysics() [2/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 368 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;
}

◆ 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.

{
  // 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.");
 
  // This will search the data paths for this relative path
  std::optional<std::string> error;
  Moose::DataFileUtils::Path found_path;
  {
    // Throw on error so that if getPath() fails, we can throw an error
    // with the context of _parent.mooseError()
    Moose::ScopedThrowOnError scoped_throw_on_error;
 
    try
    {
      found_path = Moose::DataFileUtils::getPath(relative_path);
    }
    catch (std::exception & e)
    {
      error = e.what();
    }
  }
 
  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;
}

Referenced by DataFileInterface::getDataFileNameByName().

◆ 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 126 of file PhysicsBase.h.

126{ return _factory; }

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

◆ getFactory() [2/2]

Factory & PhysicsBase::getFactory ( ) const

inlineprotectedinherited

Definition at line 127 of file PhysicsBase.h.

127{ return _factory; }

◆ getHitNode() [1/2]

const hit::Node * MooseBase::getHitNode ( ) const

inlineinherited

Returns: The block-level hit node for this object, if any

Definition at line 136 of file MooseBase.h.

136{ return getHitNode(_pars); }

Referenced by MooseBase::callMooseError(), MooseBase::getHitNode(), and MooseBase::messagePrefix().

◆ getHitNode() [2/2]

const hit::Node * MooseBase::getHitNode ( const InputParameters & params )

staticprivateinherited

Internal method for getting a hit node (if available) given a set of parameters.

Needs to be static so that we can call it externally from InputParameters for errors that do not have context of the MooseBase

Definition at line 167 of file MooseBase.C.

{
  if (const auto hit_node = params.getHitNode())
    if (!hit_node->isRoot())
      return hit_node;
  return nullptr;
}

◆ getMeshProperty() [1/2]

template<typename T >

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

inlineprotectedinherited

Definition at line 64 of file MeshMetaDataInterface.h.

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

◆ getMeshProperty() [2/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 142 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();
}

◆ getMeshPropertyInternal()

const RestartableDataValue & MeshMetaDataInterface::getMeshPropertyInternal	(	const std::string &	data_name,
		const std::string &	prefix
	)		const

privateinherited

Helper for getting a mesh property.

Definition at line 54 of file MeshMetaDataInterface.C.

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

Referenced by MeshMetaDataInterface::getMeshProperty(), and MeshMetaDataInterface::hasMeshProperty().

◆ getMooseApp()

MooseApp & MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 87 of file MooseBase.h.

87{ return _app; }

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultSteadyStateConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), Coupleable::Coupleable(), MortarInterfaceWarehouse::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), FEProblemBase::getDistribution(), FEProblemBase::getFunction(), FEProblemBase::getFVInterpolationMethod(), FEProblemBase::getMultiApp(), FEProblemBase::getSampler(), DefaultConvergenceBase::getSharedExecutionerParam(), FEProblemBase::getUserObjectBase(), FEProblemBase::getVectorPostprocessorObjectByName(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), Moose::PetscSupport::PetscOptionsScope::PetscOptionsScope(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

◆ getParam() [1/2]

template<typename T >

const T & MooseBase::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 406 of file MooseBase.h.

{
  return InputParameters::getParamHelper<T>(name, _pars);
}

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBase::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 443 of file MooseBase.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 130 of file PhysicsBase.h.

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

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

◆ getProblem() [2/2]

virtual const FEProblemBase & PhysicsBase::getProblem ( ) const

inlineprotectedvirtualinherited

Definition at line 135 of file PhysicsBase.h.

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

◆ getRenamedParam()

template<typename T >

const T & MooseBase::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 420 of file MooseBase.h.

{
  // Most important: accept new parameter
  if (isParamSetByUser(new_name) && !isParamValid(old_name))
    return getParam<T>(new_name);
  // Second most: accept old parameter
  if (isParamValid(old_name) && !isParamSetByUser(new_name))
    return getParam<T>(old_name);
  // Third most: accept default for new parameter
  if (isParamValid(new_name) && !isParamValid(old_name))
    return getParam<T>(new_name);
  // Refuse: no default, no value passed
  if (!isParamValid(old_name) && !isParamValid(new_name))
    mooseError("parameter '" + new_name +
               "' is being retrieved without being set.\nDid you misspell it?");
  // Refuse: both old and new parameters set by user
  else
    mooseError("Parameter '" + new_name + "' may not be provided alongside former parameter '" +
               old_name + "'");
}

◆ getSolverSystem() [1/2]

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

protectedinherited

Get the solver system for this variable name.

Definition at line 479 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.");
}

◆ getSolverSystem() [2/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 467 of file PhysicsBase.C.

{
  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];
}

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

◆ 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 280 of file PhysicsBase.C.

{
  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;
}

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

◆ 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 295 of file PhysicsBase.C.

{
  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;
}

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

◆ getSuppliedUserObjects()

virtual std::vector< UserObjectName > PhysicsBase::getSuppliedUserObjects ( ) const

inlinevirtualinherited

Return the names of the UserObjects this Physics adds to the problem.

A Physics that adds a UserObject that another object may reference in its constructor must declare that UserObject's name here so the construction order can be resolved regardless of input file order. This is consulted before the 'add_user_object' task runs, so it must be computable without adding the objects (i.e. from the Physics name, blocks and variables, all known after init_physics). The default is empty: a Physics that adds no such UserObject need not override.

Definition at line 118 of file PhysicsBase.h.

118{ return {}; }

Referenced by PhysicsBase::addUserObject().

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

Returns: Whether or not this object has a registered base (set via InputParameters::registerBase())

Definition at line 142 of file MooseBase.h.

142{ return _pars.hasBase(); }

InputParameters::hasBase

bool hasBase() const

Definition InputParameters.C:499

◆ hasBlocks()

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

inherited

Whether the Physics is defined on those blocks.

Parameters

blocks the blocks to check

Definition at line 571 of file PhysicsBase.C.

{
  mooseAssert(_blocks.size(), "hasBlocks called before blocks were initialized");
  return std::all_of(blocks.begin(),
                     blocks.end(),
                     [this](const SubdomainName & block)
                     { return std::find(_blocks.begin(), _blocks.end(), block) != _blocks.end(); });
}

◆ hasMeshProperty() [1/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 82 of file MeshMetaDataInterface.h.

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

◆ hasMeshProperty() [2/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 90 of file MeshMetaDataInterface.h.

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

◆ hasMeshProperty() [3/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 33 of file MeshMetaDataInterface.C.

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

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

◆ hasMeshProperty() [4/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 166 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;
}

◆ initializePhysics()

void PhysicsBase::initializePhysics ( )

privateinherited

Process some parameters that require the problem to be created. Executed on init_physics.

Definition at line 351 of file PhysicsBase.C.

{
  // Annoying edge case. We cannot use ANY_BLOCK_ID for kernels and variables since errors got
  // added downstream for using it, we cannot leave it empty as that sets all objects to not live
  // on any block
  if (isParamSetByUser("block") && _blocks.empty())
    paramError("block",
               "Empty block restriction is not supported. Comment out the Physics if you are "
               "trying to disable it.");
 
  // Components should have added their blocks already.
  if (_blocks.empty())
    _blocks.push_back("ANY_BLOCK_ID");
 
  mooseAssert(_mesh, "We should have a mesh to find the dimension");
  if (_blocks.size())
    _dim = _mesh->getBlocksMaxDimension(_blocks);
  else
    _dim = _mesh->dimension();
 
  // Forward physics verbosity to problem to output the setup
  if (_verbose)
    getProblem().setVerboseProblem(_verbose);
 
  // If the derived physics need additional initialization very early on
  initializePhysicsAdditional();
 
  // Check that the systems exist in the Problem
  // TODO: try to add the systems to the problem from here instead
  // NOTE: this must be performed after the "Additional" initialization because the list
  // of systems might have been adjusted once the dimension of the Physics is known
  const auto & problem_nl_systems = getProblem().getNonlinearSystemNames();
  const auto & problem_lin_systems = getProblem().getLinearSystemNames();
  for (const auto & sys_name : _system_names)
    if (std::find(problem_nl_systems.begin(), problem_nl_systems.end(), sys_name) ==
            problem_nl_systems.end() &&
        std::find(problem_lin_systems.begin(), problem_lin_systems.end(), sys_name) ==
            problem_lin_systems.end() &&
        solverVariableNames().size())
      mooseError("System '", sys_name, "' is not found in the Problem");
 
  // Cache system number as it makes some logic easier
  for (const auto & sys_name : _system_names)
    _system_numbers.push_back(getProblem().solverSysNum(sys_name));
}

Referenced by PhysicsBase::act().

◆ initializePhysicsAdditional()

void DiffusionFV::initializePhysicsAdditional ( )

overrideprivatevirtual

Additional initialization work that should happen very early, as soon as the problem is created.

Reimplemented from PhysicsBase.

Definition at line 41 of file DiffusionFV.C.

{
  getProblem().needFV();
}

◆ isParamSetByUser()

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

inlineinherited

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

Parameters

name	The name of the parameter to test

Definition at line 205 of file MooseBase.h.

  {
    return _pars.isParamSetByUser(name);
  }

Referenced by DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), CylinderComponent::addMeshGenerators(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), MFEMMesh::buildMesh(), MFEMBoundarySubMesh::buildSubMesh(), MFEMDomainSubMesh::buildSubMesh(), LibtorchNeuralNetControl::conditionalParameterError(), ConservativeAdvectionBCTempl< is_ad >::ConservativeAdvectionBCTempl(), MooseApp::copyInputs(), DiffusionPhysicsBase::DiffusionPhysicsBase(), MooseApp::errorCheck(), FileMesh::FileMesh(), FullSolveMultiApp::FullSolveMultiApp(), OrientSurfaceMeshGenerator::generate(), SurfaceSubdomainsFromAllNormalsGenerator::generate(), MFEMVectorFESpace::getFECName(), MooseBase::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), MFEMMesh::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MFEMVariable::MFEMVariable(), MortarConstraintBase::MortarConstraintBase(), MultiAppGeneralFieldFunctorTransfer::MultiAppGeneralFieldFunctorTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), OrientSurfaceMeshGenerator::OrientSurfaceMeshGenerator(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PolyLineMeshFollowingNodeSetGenerator::PolyLineMeshFollowingNodeSetGenerator(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), ReferenceResidualConvergence::ReferenceResidualConvergence(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::run(), MooseApp::runInputFile(), MooseApp::runInputs(), Moose::MFEM::LinearSolverBase::SetPreconditioner(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SmoothMeshGenerator::SmoothMeshGenerator(), SurfaceSubdomainsDelaunayRemesher::SurfaceSubdomainsDelaunayRemesher(), SurfaceSubdomainsFromAllNormalsGenerator::SurfaceSubdomainsFromAllNormalsGenerator(), TagVectorAux::TagVectorAux(), TimedSubdomainModifier::TimedSubdomainModifier(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), XYDelaunayGenerator::XYDelaunayGenerator(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

◆ isParamValid()

bool MooseBase::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 199 of file MooseBase.h.

199{ return _pars.isParamValid(name); }

InputParameters::isParamValid

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

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

Definition InputParameters.C:386

◆ isTransient()

bool PhysicsBase::isTransient ( ) const

protectedinherited

Return whether the Physics is solved using a transient.

Definition at line 260 of file PhysicsBase.C.

{
  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();
}

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

◆ isVariableFV()

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

protectedinherited

Whether the variable is a finite volume variable.

Definition at line 626 of file PhysicsBase.C.

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

Referenced by PhysicsBase::shouldCreateIC().

◆ 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 633 of file PhysicsBase.C.

{
  return _problem->hasScalarVariable(var_name);
}

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

◆ meshPropertyName() [1/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 103 of file MeshMetaDataInterface.h.

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

◆ meshPropertyName() [2/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 41 of file MeshMetaDataInterface.C.

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

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

◆ meshPropertyPrefix()

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

privatevirtualinherited

The default prefix to use for getting/seeing if mesh properties exist.

For now, this is not supported except in MeshGenerators. In the future, we will automate looking for mesh properties.

Reimplemented in MeshGenerator.

Definition at line 47 of file MeshMetaDataInterface.C.

{
  mooseError("This object does not support obtaining a mesh property without a prefix.\n\nThis "
             "capability is upcoming.");
}

Referenced by MeshMetaDataInterface::getMeshProperty(), MeshMetaDataInterface::hasMeshProperty(), and MeshMetaDataInterface::meshPropertyName().

◆ messagePrefix() [1/2]

std::string MooseBase::messagePrefix ( const bool hit_prefix = true ) const

inlineinherited

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

Definition at line 256 of file MooseBase.h.

  {
    return messagePrefix(_pars, hit_prefix);
  }

Referenced by MooseBase::callMooseError(), MooseBase::errorPrefix(), MooseBase::messagePrefix(), MooseBase::mooseDeprecated(), MooseBase::mooseDeprecatedNoTrace(), MooseBase::mooseInfo(), and MooseBase::mooseWarning().

◆ messagePrefix() [2/2]

std::string MooseBase::messagePrefix	(	const InputParameters &	params,
		const bool	hit_prefix
	)

staticprivateinherited

Internal method for getting the message prefix for an object (object type, name, etc).

Needs to be static so that we can call it externally from InputParameters for errors that do not have context of the MooseBase

Definition at line 140 of file MooseBase.C.

{
  std::string prefix = "";
 
  if (hit_prefix)
    if (const auto node = MooseBase::getHitNode(params))
      prefix += Moose::hitMessagePrefix(*node);
 
  // Don't have context without type and name
  if (!params.isMooseBaseObject())
    return prefix;
 
  const auto & name = params.getObjectName();
  const std::string base = params.hasBase() ? params.getBase() : "object";
  const bool is_main_app = base == "Application" && name == AppFactory::main_app_name;
  prefix += "The following occurred in the ";
  if (is_main_app)
    prefix += "main " + base;
  else
    prefix += base;
  if (base != params.getObjectName() && name.size() && !is_main_app)
    prefix += " '" + name + "'";
  prefix += " of type " + params.getObjectType() + ".";
  return prefix + "\n\n";
}

◆ mooseDeprecated() [1/2]

template<typename... Args>

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

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and a stack trace.

Definition at line 317 of file MooseBase.h.

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

Referenced by MooseApp::addCapability(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), MooseApp::getRecoverFileBase(), MooseApp::hasRecoverFileBase(), and MooseApp::setupOptions().

◆ mooseDeprecated() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 87 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::mooseDeprecated(std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": deprecation");
  }

Referenced by MultiApp::appProblem(), AddVariableAction::determineType(), MooseMesh::elem(), MooseMesh::elem(), FunctionDT::FunctionDT(), MooseMesh::getBoundariesToElems(), Control::getExecuteOptions(), MooseMesh::isTranslatedPeriodic(), MooseMesh::minPeriodicDistance(), MooseMesh::minPeriodicVector(), MooseMesh::node(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), and MooseMesh::setBoundaryToNormalMap().

◆ mooseDeprecatedNoTrace()

template<typename... Args>

void MooseBase::mooseDeprecatedNoTrace ( Args &&... args ) const

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and no stack trace.

Definition at line 327 of file MooseBase.h.

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

◆ mooseDocumentedError()

template<typename... Args>

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

inlineinherited

Definition at line 277 of file MooseBase.h.

  {
    callMooseError(moose::internal::formatMooseDocumentedError(
                       repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
                   /* with_prefix = */ true);
  }

Referenced by ManifoldSubdomainGenerator::ManifoldSubdomainGenerator().

◆ mooseError()

template<typename... Args>

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

inlineinherited

Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

Definition at line 271 of file MooseBase.h.

  {
    callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ true);
  }

◆ mooseErrorInternal()

template<typename... Args>

void MeshMetaDataInterface::mooseErrorInternal ( Args &&... args ) const

inlineprivateinherited

Helper for forwarding a mooseError to an object's mooseError if it is available (said error will provide more context: object name and type)

Definition at line 132 of file MeshMetaDataInterface.h.

  {
    if (_meta_data_object)
      _meta_data_object->mooseError(std::forward<Args>(args)...);
    mooseError(std::forward<Args>(args)...);
  }

Referenced by MeshMetaDataInterface::getMeshProperty().

◆ mooseErrorNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 290 of file MooseBase.h.

  {
    callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ false);
  }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 334 of file MooseBase.h.

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

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), PIDTransientControl::execute(), Executioner::Executioner(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), FixedPointSolve::findTransformedSystem(), ManifoldSubdomainGenerator::generate(), PolyLineMeshFollowingNodeSetGenerator::generate(), DataFileInterface::getDataFilePath(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), MultiAppTransfer::mapBackWithoutCollapsing(), SolutionInvalidityOutput::output(), MooseBase::paramInfo(), MooseApp::setupOptions(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

◆ mooseWarning() [1/2]

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 299 of file MooseBase.h.

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

Referenced by DiracKernelInfo::findPoint(), DataFileInterface::getDataFilePath(), MooseApp::loadLibraryAndDependencies(), and MooseBase::paramWarning().

◆ mooseWarning() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 73 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::mooseWarning(std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
  }

Referenced by CopyMeshPartitioner::_do_partition(), AddFunctionAction::act(), AddKernelAction::act(), CommonOutputAction::act(), MaterialOutputAction::act(), MeshOnlyAction::act(), MooseMesh::addPeriodicVariable(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkPolygons(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), MultiApp::createApp(), MeshDiagnosticsGenerator::diagnosticsLog(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), Postprocessor::evaluateDotWarning(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), BSplineCurveGenerator::generate(), RenumberBySubdomainGenerator::generate(), SubdomainPerElementGenerator::generate(), SurfaceMeshGeneratorBase::get2DElemNormal(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), IndicatorMarker::IndicatorMarker(), CartesianGridDivision::initialize(), CylindricalGridDivision::initialize(), SphericalGridDivision::initialize(), MFEMRefinementMarker::initialSetup(), MaterialBase::initStatefulProperties(), IterationAdaptiveDT::limitDTToPostprocessorValue(), NewmarkBeta::NewmarkBeta(), Output::Output(), MaterialOutputAction::outputHelper(), Executioner::problem(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), MooseMesh::setCoordSystem(), TransientMultiApp::solveStep(), MeshRepairGenerator::splitNonConvexPolygons(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

◆ mooseWarningNonPrefixed() [1/2]

template<typename... Args>

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

inlineinherited

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

Definition at line 308 of file MooseBase.h.

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

◆ mooseWarningNonPrefixed() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 80 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::mooseWarningNonPrefixed(std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
  }

◆ name()

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

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 103 of file MooseBase.h.

  {
    mooseAssert(_name.size(), "Empty name");
    return _name;
  }

◆ paramError()

template<typename... Args>

void MooseBase::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 457 of file MooseBase.h.

{
  _pars.paramError(param, std::forward<Args>(args)...);
}

◆ 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 126 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 & MooseBase::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 131 of file MooseBase.h.

131{ return _pars; }

◆ paramInfo()

template<typename... Args>

void MooseBase::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 471 of file MooseBase.h.

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

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

◆ paramWarning() [1/2]

template<typename... Args>

void MooseBase::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 464 of file MooseBase.h.

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

◆ paramWarning() [2/2]

template<typename... Args>

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

inlineinherited

Definition at line 94 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::paramWarning(param, std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning for parameter '" +
                                            param + "'");
  }

Referenced by GridPartitioner::_do_partition(), CartesianMeshGenerator::CartesianMeshGenerator(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), EigenProblem::checkProblemIntegrity(), MooseMeshUtils::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), PlaneIDMeshGenerator::generate(), SubdomainsFromPartitionerGenerator::generate(), UniqueExtraIDMeshGenerator::generate(), ReferenceResidualConvergence::initialSetup(), FullSolveMultiApp::initialSetup(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), PNGOutput::PNGOutput(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

◆ perfGraph()

PerfGraph & PerfGraphInterface::perfGraph ( )

inherited

Get the PerfGraph.

Definition at line 86 of file PerfGraphInterface.C.

{
  return _pg_moose_app.perfGraph();
}

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

◆ prefix()

std::string PhysicsBase::prefix ( ) const

inlineprotectedinherited

Use prefix() to disambiguate names.

Definition at line 153 of file PhysicsBase.h.

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

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

◆ prepareCopyVariablesFromMesh()

void PhysicsBase::prepareCopyVariablesFromMesh ( ) const

protectedinherited

Tell the app if we want to use Exodus restart.

Definition at line 250 of file PhysicsBase.C.

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

Referenced by PhysicsBase::PhysicsBase().

◆ queryParam()

template<typename T >

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

inherited

Query a parameter for the object.

If a parameter of the given name and type does not exist or 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 413 of file MooseBase.h.

{
  return _pars.queryParam<T>(name);
}

Referenced by MFEMExecutedObject::getRequestedItems(), and MFEMGeometricMultigridSolver::MFEMGeometricMultigridSolver().

◆ registerInvalidSolutionInternal()

InvalidSolutionID SolutionInvalidInterface::registerInvalidSolutionInternal	(	const std::string &	message,
		const bool	warning
	)		const

protectedinherited

Definition at line 55 of file SolutionInvalidInterface.C.

{
  return moose::internal::getSolutionInvalidityRegistry().registerInvalidity(
      _si_moose_base.type(), message, warning);
}

◆ 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 61 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 72 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 std::string &	object_name = `""`
	)		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
object_type	the type of the object we are not building (thus ignoring the parameters)
object_name	the name of the object we are not building

Definition at line 826 of file PhysicsBase.C.

{
  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);
  }
  const std::string object_name_string =
      object_name.empty() ? "" : ("and name '" + object_name + "' ");
 
  if (defaults_unused.size() && _verbose)
    mooseInfoRepeated("Defaults for parameters '" + Moose::stringify(defaults_unused) +
                      "' for object of type '" + object_type + "' " + object_name_string +
                      "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 + "' " + object_name_string +
          "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 + "' " + object_name_string +
                 "were not used because the corresponding object was not created by this Physics.");
  }
}

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

◆ 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 171 of file PhysicsBase.h.

171{ _aux_var_names.push_back(var_name); }

◆ 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 166 of file PhysicsBase.h.

  {
    _solver_var_names.push_back(var_name);
  }

Referenced by DiffusionPhysicsBase::DiffusionPhysicsBase().

◆ 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 663 of file PhysicsBase.C.

{
  // 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);
    // FV variables can be initialized by non-FV ICs
    std::set<SubdomainID> blocks_ids_covered_fe;
    const bool has_all_blocks_from_feics =
        _problem->getInitialConditionWarehouse().hasObjectsForVariableAndBlocks(
            var_name, blocks_ids_set, blocks_ids_covered_fe, /*tid =*/0);
    // Note we are missing the case with complete but split coverage
    has_all_blocks = has_all_blocks || has_all_blocks_from_feics;
    blocks_ids_covered.insert(blocks_ids_covered_fe.begin(), blocks_ids_covered_fe.end());
  }
  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.");
}

Referenced by DiffusionPhysicsBase::addInitialConditions().

◆ 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 725 of file PhysicsBase.C.

{
  // 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.");
}

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

◆ 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 639 of file PhysicsBase.C.

{
  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.");
}

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

◆ solverVariableExists()

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

protectedinherited

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

Definition at line 461 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 104 of file PhysicsBase.h.

104{ return _solver_var_names; };

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

◆ specificTaskName()

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

inlineinherited

Definition at line 110 of file Action.h.

110{ 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:159

◆ timedAct()

void Action::timedAct ( )

inherited

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

Definition at line 76 of file Action.C.

{
  TIME_SECTION(_act_timer);
 
  const auto parallel_verify = [libmesh_dbg_var(this)](const bool libmesh_dbg_var(before))
  {
#ifndef NDEBUG
    const std::string value = this->typeAndName() + "_" + _current_task;
    if (!comm().verify(value.size()) || !comm().verify(value))
      mooseError("Parallel inconsistency found ",
                 before ? "before" : "after",
                 " executing task ",
                 _current_task);
#endif
  };
 
  parallel_verify(true);
 
  act();
 
  parallel_verify(false);
}

Referenced by ActionWarehouse::executeActionsWithAction().

◆ 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 55 of file PerfGraphInterface.C.

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

Referenced by PerfGraphInterface::registerTimedSection(), and PerfGraphInterface::registerTimedSection().

◆ 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 93 of file MooseBase.h.

  {
    mooseAssert(_type.size(), "Empty type");
    return _type;
  }

◆ 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 57 of file MooseBase.C.

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

Referenced by MaterialPropertyStorage::addProperty(), FEProblemBase::checkUserObjectNameCollision(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< T >::finalize(), ReporterData::getReporterInfo(), MFEMSamplerBase::initialSetup(), MFEMVariableSamplerBase::initialSetup(), WebServerControl::outputMessage(), and Action::timedAct().

◆ uniqueActionName()

MooseObjectName Action::uniqueActionName ( ) const

inlineinherited

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

Definition at line 108 of file Action.h.

108{ return uniqueName(); }

Referenced by NEML2Action::NEML2Action().

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

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

Definition at line 69 of file MooseBase.C.

{
  if (!_pars.have_parameter<std::string>(unique_name_param))
    mooseError("uniqueName(): Object does not have a unique name");
  return MooseObjectName(_pars.get<std::string>(unique_name_param));
}

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

◆ uniqueParameterName()

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

inherited

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

Definition at line 63 of file MooseBase.C.

{
  return MooseObjectParameterName(getBase(), name(), parameter_name);
}

◆ validParams()

InputParameters DiffusionFV::validParams ( )

static

Definition at line 20 of file DiffusionFV.C.

{
  InputParameters params = DiffusionPhysicsBase::validParams();
  params.addClassDescription("Add diffusion physics discretized with cell-centered finite volume");
  // No kernel implemented in the framework for a material property diffusivity
  params.suppressParameter<MaterialPropertyName>("diffusivity_matprop");
  params.addRequiredParam<MooseFunctorName>("diffusivity_functor",
                                            "Functor specifying the diffusivity");
 
  params.addParam<unsigned short>(
      "ghost_layers", 2, "Number of ghosting layers for distributed memory parallel calculations");
  params.addParamNamesToGroup("ghost_layers", "Advanced");
  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 448 of file PhysicsBase.C.

{
  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);
}

Referenced by PhysicsBase::shouldCreateVariable().

◆ 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 132 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.getObjectName() +
                        "\" of type \"" + other_param.getObjectType() + "\"");
}

Member Data Documentation

◆ _act_timer

PerfID Action::_act_timer

protectedinherited

Timers.

Definition at line 181 of file Action.h.

Referenced by Action::timedAct().

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory

protectedinherited

Builds Actions.

Definition at line 40 of file ParallelParamObject.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 166 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 375 of file MooseBase.h.

Referenced by ElementIDOutputAction::act(), AdaptivityAction::act(), AddExecutorAction::act(), AddMeshGeneratorAction::act(), AddPeriodicBCAction::act(), AddRelationshipManager::act(), AddTimeStepperAction::act(), AutoCheckpointAction::act(), CheckIntegrityAction::act(), CombineComponentsMeshes::act(), CommonOutputAction::act(), ComposeTimeStepperAction::act(), CopyNodalVarsAction::act(), CouplingFunctorCheckAction::act(), CreateAddedMeshGenerators::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), CSGOnlyAction::act(), DeclareLateReportersAction::act(), DisplayGhostingAction::act(), ExecuteMeshGenerators::act(), MaterialOutputAction::act(), MeshOnlyAction::act(), ReadExecutorParamsAction::act(), ResolveOptionalMaterialPropertiesAction::act(), SetAdaptivityOptionsAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), SetupMeshCompleteAction::act(), SetupPredictorAction::act(), SetupRecoverFileBaseAction::act(), SetupTimeStepperAction::act(), SplitMeshAction::act(), Action::Action(), BatchMeshGeneratorAction::addMeshGenerators(), ComponentJunction::addMeshGenerators(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), AddActionComponentAction::addRelationshipManagers(), BatchMeshGeneratorAction::BatchMeshGeneratorAction(), CheckOutputAction::checkConsoleOutput(), CheckOutputAction::checkMaterialOutput(), CheckOutputAction::checkPerfLogOutput(), CheckOutputAction::checkVariableOutput(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), NEML2Action::NEML2Action(), PhysicsBase::prepareCopyVariablesFromMesh(), NEML2Action::printSummary(), PhysicsBase::reportPotentiallyMissedParameters(), MeshGeneratorComponent::setupComponent(), SetupMeshAction::setupMesh(), and PhysicsBase::shouldCreateIC().

◆ _aux_var_names

std::vector<VariableName> PhysicsBase::_aux_var_names

privateinherited

Vector of the aux variables in the Physics.

Definition at line 356 of file PhysicsBase.h.

Referenced by PhysicsBase::act(), PhysicsBase::auxVariableNames(), and PhysicsBase::saveAuxVariableName().

◆ _awh

ActionWarehouse& Action::_awh

protectedinherited

Reference to ActionWarehouse where we store object build by actions.

Definition at line 169 of file Action.h.

Referenced by AddActionComponentAction::act(), AddRelationshipManager::act(), CheckIntegrityAction::act(), CombineComponentsMeshes::act(), CreateExecutionerAction::act(), CreateMeshSetupActionsForComponents::act(), CreateProblemDefaultAction::act(), ReadExecutorParamsAction::act(), SetupDampersAction::act(), SetupMeshAction::act(), SetupTimeStepperAction::act(), AddActionComponentAction::AddActionComponentAction(), ComponentJunction::addMeshGenerators(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), PhysicsBase::getActionComponent(), NEML2Action::getCommonAction(), PhysicsBase::getCoupledPhysics(), 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 295 of file PhysicsBase.h.

Referenced by PhysicsBase::addBlocks(), PhysicsBase::addBlocksById(), PhysicsBase::addComponent(), DiffusionCG::addFEKernels(), addFVKernels(), DiffusionPhysicsBase::addInitialConditions(), DiffusionCG::addSolverVariables(), addSolverVariables(), PhysicsBase::blocks(), PhysicsBase::checkBlockRestrictionIdentical(), PhysicsBase::hasBlocks(), 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(), PhysicsComponentInterface::addBoundaryConditionsFromComponents(), and DiffusionCG::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(), PhysicsComponentInterface::addInitialConditionsFromComponents(), and DiffusionPhysicsBase::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 172 of file Action.h.

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

◆ _customer_class

const PhysicsBase * const InputParametersChecksUtils< PhysicsBase >::_customer_class

privateinherited

Definition at line 200 of file InputParametersChecksUtils.h.

◆ _dim

unsigned int PhysicsBase::_dim = libMesh::invalid_uint

privateinherited

Dimension of the physics, which we expect for now to be the dimension of the mesh NOTE: this is not known at construction time, only after initializePhysics which is a huge bummer.

Definition at line 360 of file PhysicsBase.h.

Referenced by PhysicsBase::addBlocks(), PhysicsBase::addBlocksById(), PhysicsBase::dimension(), and PhysicsBase::initializePhysics().

◆ _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 DiffusionCG::addFEBCs(), and addFVBCs().

◆ _displaced_mesh

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

protectedinherited

Definition at line 175 of file Action.h.

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

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

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

◆ _is_transient

MooseEnum PhysicsBase::_is_transient

privateinherited

Whether the physics is to be solved as a transient.

It can be advantageous to solve some physics directly to steady state

Definition at line 351 of file PhysicsBase.h.

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

◆ _mesh

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

protectedinherited

◆ _meta_data_app

MooseApp& MeshMetaDataInterface::_meta_data_app

privateinherited

Reference to the application.

Definition at line 122 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::getMeshPropertyInternal(), and MeshMetaDataInterface::hasMeshProperty().

◆ _meta_data_object

const MooseObject* const MeshMetaDataInterface::_meta_data_object

privateinherited

The MooseObject (if any); used for better error handling.

Definition at line 125 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::mooseErrorInternal().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 381 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 DiffusionCG::addFEBCs(), and addFVBCs().

◆ _parent

const ParallelParamObject& DataFileInterface::_parent

privateinherited

Definition at line 58 of file DataFileInterface.h.

Referenced by DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), and DataFileInterface::getDataFilePath().

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 384 of file MooseBase.h.

Referenced by AddAuxKernelAction::act(), AddFVICAction::act(), AddICAction::act(), CommonOutputAction::act(), ComposeTimeStepperAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), AddMFEMComplexBCComponentAction::act(), AddMFEMComplexKernelComponentAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), Moose::Kokkos::MaterialBase::declareKokkosOnDemandProperty(), Moose::Kokkos::MaterialBase::declareKokkosProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateCSG(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), EigenProblemSolve::initialSetup(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MultiSystemSolveObject::MultiSystemSolveObject(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), MooseBase::queryParam(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _pg_moose_app

MooseApp& PerfGraphInterface::_pg_moose_app

protectedinherited

The MooseApp that owns the PerfGraph.

Definition at line 135 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 292 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 138 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 178 of file Action.h.

◆ _registered_identifier

std::string Action::_registered_identifier

protectedinherited

Definition at line 151 of file Action.h.

Referenced by SetupMeshAction::act().

◆ _required_tasks

std::set<std::string> PhysicsBase::_required_tasks

privateinherited

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

Definition at line 363 of file PhysicsBase.h.

Referenced by PhysicsBase::addRequiredPhysicsTask(), and PhysicsBase::checkRequiredTasks().

◆ _si_moose_base

const MooseBase& SolutionInvalidInterface::_si_moose_base

privateinherited

The MooseBase that owns this interface.

Definition at line 111 of file SolutionInvalidInterface.h.

Referenced by SolutionInvalidInterface::flagInvalidSolutionInternal(), SolutionInvalidInterface::mooseDeprecated(), SolutionInvalidInterface::mooseWarning(), SolutionInvalidInterface::mooseWarningNonPrefixed(), SolutionInvalidInterface::paramWarning(), and SolutionInvalidInterface::registerInvalidSolutionInternal().

◆ _si_problem

const FEProblemBase* SolutionInvalidInterface::_si_problem

privateinherited

A pointer to FEProblem base.

Definition at line 114 of file SolutionInvalidInterface.h.

Referenced by SolutionInvalidInterface::flagInvalidSolutionInternal().

◆ _solver_var_names

std::vector<VariableName> PhysicsBase::_solver_var_names

privateinherited

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

Definition at line 354 of file PhysicsBase.h.

Referenced by PhysicsBase::checkIntegrityEarly(), PhysicsBase::getSolverSystem(), PhysicsBase::saveSolverVariableName(), and PhysicsBase::solverVariableNames().

◆ _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 159 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 282 of file PhysicsBase.h.

Referenced by PhysicsBase::checkIntegrityEarly(), PhysicsBase::getSolverSystem(), 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 285 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 378 of file MooseBase.h.

Referenced by FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), MooseBase::MooseBase(), FEProblemBase::solverTypeString(), and MooseBase::type().

◆ _var_name

const VariableName& DiffusionPhysicsBase::_var_name

protectedinherited

Name of the diffused variable.

Definition at line 36 of file DiffusionPhysicsBase.h.

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

◆ _verbose

const bool PhysicsBase::_verbose

protectedinherited

Whether to output additional information.

Definition at line 288 of file PhysicsBase.h.

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

◆ app_param

const std::string MooseBase::app_param = "_moose_app"

staticinherited

The name of the parameter that contains the MooseApp.

Definition at line 59 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MeshGenerator::addMeshSubgenerator(), InputParameters::callMooseError(), ActionFactory::create(), ActionFactory::getValidParams(), Factory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ kokkos_object_param

const std::string MooseBase::kokkos_object_param = "_kokkos_object"

staticinherited

The name of the parameter that indicates an object is a Kokkos functor.

Definition at line 64 of file MooseBase.h.

Referenced by InputParameters::isKokkosObject().

◆ moose_base_param

const std::string MooseBase::moose_base_param = "_moose_base"

staticinherited

The name of the parameter that contains the moose system base.

Definition at line 61 of file MooseBase.h.

Referenced by InputParameters::getBase(), InputParameters::hasBase(), and InputParameters::registerBase().

◆ NAME

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

staticconstexprinherited

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

Definition at line 33 of file MeshMetaDataInterface.h.

◆ name_param

const std::string MooseBase::name_param = "_object_name"

staticinherited

The name of the parameter that contains the object name.

Definition at line 55 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), ActionUnitTest::buildMinimalObjects(), MooseObjectUnitTest::buildObjects(), AppFactory::create(), InputParameters::getObjectName(), AutomaticMortarGeneration::initOutput(), InputParameters::isMooseBaseObject(), MooseMesh::prepare(), CouplingFunctorCheckAction::validParams(), and MooseBase::validParams().

◆ SYSTEM

constexpr auto MeshMetaDataInterface::SYSTEM = "MeshMetaData"

staticconstexprinherited

The system name used when initializing the Restartable interface.

Definition at line 30 of file MeshMetaDataInterface.h.

Referenced by MeshMetaDataInterface::meshPropertyName().

◆ type_param

const std::string MooseBase::type_param = "_type"

staticinherited

The name of the parameter that contains the object type.

Definition at line 53 of file MooseBase.h.

Referenced by ActionFactory::create(), AppFactory::create(), InputParameters::getObjectType(), Factory::initialize(), InputParameters::isMooseBaseObject(), InputParameters::queryObjectType(), MooseBase::validParams(), and MortarNodalGeometryOutput::validParams().

◆ unique_action_name_param

const std::string Action::unique_action_name_param = "_unique_action_name"

staticinherited

The name of the parameter that contains the unique action name.

Definition at line 41 of file Action.h.

Referenced by Action::validParams().

◆ unique_name_param

const std::string MooseBase::unique_name_param = "_unique_name"

staticinherited

The name of the parameter that contains the unique object name.

Definition at line 57 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), AppFactory::create(), InputParameterWarehouse::removeInputParameters(), MooseBase::uniqueName(), and MooseBase::validParams().

◆ usingCombinedWarningSolutionWarnings

Action::usingCombinedWarningSolutionWarnings

inherited

Definition at line 55 of file Action.h.

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

include/physics/DiffusionFV.h
src/physics/DiffusionFV.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

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Constructor & Destructor Documentation

◆ DiffusionFV()

Member Function Documentation

◆ act()

◆ actOnAdditionalTasks()

◆ addAuxiliaryKernels()

◆ addAuxiliaryVariables()

◆ addBlocks()

◆ addBlocksById()

◆ addBoundaryCondition()

◆ addBoundaryConditionsFromComponents()

◆ addComponent() [1/2]

◆ addComponent() [2/2]

◆ addCorrectors()

◆ addDGKernels()

◆ addDiracKernels()

◆ addExecutioner()

◆ addExecutors()

◆ addFEBCs()

◆ addFEKernels()

◆ addFunctions()

◆ addFunctorMaterials()

◆ addFVBCs()

◆ addFVInterfaceKernels()

◆ addFVInterpolationMethods()

◆ addFVKernels()

◆ addInitialCondition()

◆ addInitialConditions()

◆ addInitialConditionsFromComponents()

◆ addInterfaceKernels()

◆ addMaterials()

◆ addMultiApps()

◆ addNodalBCs()

◆ addNodalKernels()

◆ addOutputs()

◆ addPeriodicBCs()

◆ addPetscPairsToPetscOptions()

◆ addPostprocessors()

◆ addPreconditioning()

◆ addRelationshipManager()

◆ addRelationshipManagers() [1/3]

◆ addRelationshipManagers() [2/3]

◆ addRelationshipManagers() [3/3]

◆ addReporters()

◆ addRequiredPhysicsTask()

◆ addScalarKernels()

◆ addSolverVariables()

◆ addTransfers()

◆ addUserObject()

◆ addUserObjects()

◆ addVectorPostprocessors()

◆ allMeshBlocks() [1/2]

◆ allMeshBlocks() [2/2]

◆ appendTask()

◆ assertParamDefined() [1/2]

◆ assertParamDefined() [2/2]

◆ assignBlocks()

◆ associateWithParameter() [1/2]

◆ associateWithParameter() [2/2]

◆ auxVariableNames()

◆ blocks()

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ checkBlockRestrictionIdentical()

◆ checkBlockwiseConsistency()

◆ checkComponentType()