https://mooseframework.inl.gov
Loading...
Searching...
No Matches
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 | List of all members
MultiSpeciesDiffusionCG Class Reference

Creates all the objects needed to solve diffusion equations for multiple species with a continuous Galerkin finite element discretization. More...

#include <MultiSpeciesDiffusionCG.h>

Inheritance diagram for MultiSpeciesDiffusionCG:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 MultiSpeciesDiffusionCG (const InputParameters &parameters)
 
void addComponent (const ActionComponent &component) override
 
virtual InputParameters getAdditionalRMParams () const
 
virtual void act () override final
 
virtual void actOnAdditionalTasks ()
 
void addBlocks (const std::vector< SubdomainName > &blocks)
 
void addBlocksById (const std::vector< SubdomainID > &block_ids)
 
const std::vector< SubdomainName > & blocks () const
 
bool checkBlockRestrictionIdentical (const std::string &object_name, const std::vector< SubdomainName > &blocks, const bool error_if_not_identical=true) const
 
bool hasBlocks (const std::vector< SubdomainName > &blocks) const
 
const T * getCoupledPhysics (const PhysicsName &phys_name, const bool allow_fail=false) const
 
const std::vector< T * > getCoupledPhysics (const bool allow_fail=false) const
 
unsigned int dimension () const
 
const ActionComponent & getActionComponent (const ComponentName &comp_name) const
 
void checkComponentType (const ActionComponent &component) const
 
const std::vector< VariableName > & solverVariableNames () const
 
const std::vector< VariableName > & auxVariableNames () const
 
virtual std::vector< UserObjectName > getSuppliedUserObjects () const
 
void timedAct ()
 
MooseObjectName uniqueActionName () const
 
const std::string & specificTaskName () const
 
const std::set< std::string > & getAllTasks () const
 
void appendTask (const std::string &task)
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
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
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
PerfGraph & perfGraph ()
 
void assertParamDefined (const std::string &libmesh_dbg_var(param)) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
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)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string unique_action_name_param
 
static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void addSolverVariables () override
 
virtual void addFEKernels () override
 
virtual void addFEBCs () override
 
void assertParamDefined (const std::string &param) const
 
bool isTransient () const
 
Factory & getFactory ()
 
Factory & getFactory () const
 
virtual FEProblemBase & getProblem ()
 
virtual const FEProblemBase & getProblem () const
 
void prepareCopyVariablesFromMesh () const
 
void copyVariablesFromMesh (const std::vector< VariableName > &variables_to_copy, bool are_nonlinear=true)
 
std::string prefix () const
 
void addUserObject (const std::string &uo_type, const std::string &uo_name, InputParameters &params)
 
void saveSolverVariableName (const VariableName &var_name)
 
void saveAuxVariableName (const VariableName &var_name)
 
bool variableExists (const VariableName &var_name, bool error_if_aux) const
 
bool solverVariableExists (const VariableName &var_name) const
 
const SolverSystemName & getSolverSystem (unsigned int variable_index) const
 
const SolverSystemName & getSolverSystem (const VariableName &variable_name) const
 
void addRequiredPhysicsTask (const std::string &task)
 
void assignBlocks (InputParameters &params, const std::vector< SubdomainName > &blocks) const
 
bool allMeshBlocks (const std::vector< SubdomainName > &blocks) const
 
bool allMeshBlocks (const std::set< SubdomainName > &blocks) const
 
std::set< SubdomainID > getSubdomainIDs (const std::set< SubdomainName > &blocks) const
 
std::vector< std::string > getSubdomainNamesAndIDs (const std::set< SubdomainID > &blocks) const
 
void addPetscPairsToPetscOptions (const std::vector< std::pair< MooseEnumItem, std::string > > &petsc_pair_options)
 
bool isVariableFV (const VariableName &var_name) const
 
bool isVariableScalar (const VariableName &var_name) const
 
bool shouldCreateVariable (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_aux)
 
bool shouldCreateIC (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool ic_is_default_ic, const bool error_if_already_defined) const
 
bool shouldCreateTimeDerivative (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const
 
void reportPotentiallyMissedParameters (const std::vector< std::string > &param_names, const std::string &object_type, const std::string &object_name="") const
 
virtual void checkIntegrity () const
 
void associateWithParameter (const std::string &param_name, InputParameters &params) const
 
void associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
void checkParamsBothSetOrNotSet (const std::string &param1, const std::string &param2) const
 
void checkSecondParamSetOnlyIfFirstOneTrue (const std::string &param1, const std::string &param2) const
 
void checkSecondParamSetOnlyIfFirstOneSet (const std::string &param1, const std::string &param2) const
 
void checkSecondParamNotSetIfFirstOneSet (const std::string &param1, const std::string &param2) const
 
void checkVectorParamsSameLength (const std::string &param1, const std::string &param2) const
 
void checkVectorParamAndMultiMooseEnumLength (const std::string &param1, const std::string &param2) const
 
void checkTwoDVectorParamsSameLength (const std::string &param1, const std::string &param2) const
 
void checkVectorParamsNoOverlap (const std::vector< std::string > &param_vecs) const
 
void checkTwoDVectorParamsNoRespectiveOverlap (const std::vector< std::string > &param_vecs) const
 
void checkTwoDVectorParamInnerSameLengthAsOneDVector (const std::string &param1, const std::string &param2) const
 
void checkTwoDVectorParamMultiMooseEnumSameLength (const std::string &param1, const std::string &param2, const bool error_for_param2) const
 
void checkVectorParamNotEmpty (const std::string &param1) const
 
void checkVectorParamsSameLengthIfSet (const std::string &param1, const std::string &param2, const bool ignore_empty_default_param2=false) const
 
void checkVectorParamLengthSameAsCombinedOthers (const std::string &param1, const std::string &param2, const std::string &param3) const
 
void checkBlockwiseConsistency (const std::string &block_param_name, const std::vector< std::string > &parameter_names) const
 
bool parameterConsistent (const InputParameters &other_param, const std::string &param_name) const
 
void warnInconsistent (const InputParameters &parameters, const std::string &param_name) const
 
void errorDependentParameter (const std::string &param1, const std::string &value_not_set, const std::vector< std::string > &dependent_params) const
 
void errorInconsistentDependentParameter (const std::string &param1, const std::string &value_set, const std::vector< std::string > &dependent_params) const
 

Static Protected Member Functions

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

Protected Attributes

const std::vector< VariableName > & _species_names
 Name of the diffused variables.
 
const unsigned int _num_species
 Number of species.
 
const std::vector< std::vector< BoundaryName > > & _neumann_boundaries
 Boundaries on which a Neumann boundary condition is applied. Outer indexing is variables.
 
const std::vector< std::vector< BoundaryName > > & _dirichlet_boundaries
 Boundaries on which a Dirichlet boundary condition is applied. Outer indexing is variables.
 
const bool _use_ad
 Whether to use automatic differentiation or not.
 
std::vector< SolverSystemName > _system_names
 
std::vector< unsigned int > _system_numbers
 
const bool _verbose
 
const MooseEnum & _preconditioning
 
std::vector< SubdomainName > _blocks
 
std::string _registered_identifier
 
std::string _specific_task_name
 
std::set< std::string > _all_tasks
 
ActionWarehouse & _awh
 
const std::string & _current_task
 
std::shared_ptr< MooseMesh > & _mesh
 
std::shared_ptr< MooseMesh > & _displaced_mesh
 
std::shared_ptr< FEProblemBase > & _problem
 
PerfID _act_timer
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Private Member Functions

virtual void addPreconditioning () override
 Add default preconditioning options.
 
virtual void addPostprocessors () override
 Add postprocessing of the fluxes.
 
virtual void addInitialConditions () override
 Add initial conditions for each diffused variable.
 
virtual void addRelationshipManagers (Moose::RelationshipManagerType input_rm_type) override
 
bool addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
 
virtual void addRelationshipManagers (Moose::RelationshipManagerType when_type)
 
void initializePhysics ()
 
virtual void initializePhysicsAdditional ()
 
virtual void checkIntegrityEarly () const
 
virtual void addAuxiliaryVariables ()
 
virtual void addFVKernels ()
 
virtual void addFVInterpolationMethods ()
 
virtual void addNodalKernels ()
 
virtual void addDiracKernels ()
 
virtual void addDGKernels ()
 
virtual void addScalarKernels ()
 
virtual void addInterfaceKernels ()
 
virtual void addFVInterfaceKernels ()
 
virtual void addFVBCs ()
 
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
 
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)
 
virtual std::string meshPropertyPrefix (const std::string &data_name) const
 
const RestartableDataValue & getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const
 
void mooseErrorInternal (Args &&... args) const
 
const T & forwardGetParam (const std::string &param_name) const
 
const InputParameters & forwardParameters () const
 
bool forwardIsParamSetByUser (const std::string &param_name) const
 
bool forwardIsParamValid (const std::string &param_name) const
 
void forwardParamError (Args &&... args) const
 
void forwardMooseError (Args &&... args) const
 
void forwardMooseWarning (Args &&... args) const
 
const std::string & forwardType () const
 
virtual const std::string & forwardName () const
 
const std::vector< SubdomainName > & forwardBlocks () const
 

Static Private Member Functions

static const hit::Node * getHitNode (const InputParameters &params)
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 

Private Attributes

MooseEnum _is_transient
 
std::vector< VariableName > _solver_var_names
 
std::vector< VariableName > _aux_var_names
 
unsigned int _dim
 
std::set< std::string > _required_tasks
 
const ParallelParamObject & _parent
 
MooseApp & _meta_data_app
 
const MooseObject *const _meta_data_object
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
const PhysicsBase *const _customer_class
 

Detailed Description

Creates all the objects needed to solve diffusion equations for multiple species with a continuous Galerkin finite element discretization.

Definition at line 18 of file MultiSpeciesDiffusionCG.h.

Constructor & Destructor Documentation

◆ MultiSpeciesDiffusionCG()

MultiSpeciesDiffusionCG::MultiSpeciesDiffusionCG ( const InputParameters &  parameters)

Definition at line 30 of file MultiSpeciesDiffusionCG.C.

31 : MultiSpeciesDiffusionPhysicsBase(parameters)
32{
33}
PhysicsBase::parameters
const InputParameters & parameters() const
MultiSpeciesDiffusionPhysicsBase
Base class to host all common parameters and attributes of Physics actions to solve the diffusion equ...
Definition MultiSpeciesDiffusionPhysicsBase.h:27

Member Function Documentation

◆ addComponent()

void MultiSpeciesDiffusionPhysicsBase::addComponent ( const ActionComponent &  component)
overridevirtualinherited

Reimplemented from PhysicsBase.

Definition at line 158 of file MultiSpeciesDiffusionPhysicsBase.C.

159{
160 for (const auto & block : component.blocks())
161 _blocks.push_back(block);
162}
PhysicsBase::_blocks
std::vector< SubdomainName > _blocks
PhysicsBase::blocks
const std::vector< SubdomainName > & blocks() const
RankTwoScalarTools::component
T component(const RankTwoTensorTempl< T > &r2tensor, unsigned int i, unsigned int j)
Definition RankTwoScalarTools.h:67

◆ addFEBCs()

void MultiSpeciesDiffusionCG::addFEBCs ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 132 of file MultiSpeciesDiffusionCG.C.

133{
134 if (isParamSetByUser("neumann_boundaries"))
135 {
136 const auto & boundary_fluxes =
137 getParam<std::vector<std::vector<MooseFunctorName>>>("boundary_fluxes");
138
139 for (const auto s : index_range(_species_names))
140 {
141 const auto & var_name = _species_names[s];
142
143 for (const auto i : index_range(_neumann_boundaries[s]))
144 {
145 const auto & bc_flux = boundary_fluxes[s][i];
146 // Select the boundary type based on the user parameters and what we know to be most
147 // efficient We could actually just use the very last option for everything but the
148 // performance is better if one uses the specialized objects
149 std::string bc_type = "";
150 if (MooseUtils::parsesToReal(bc_flux))
151 bc_type = _use_ad ? "ADNeumannBC" : "NeumannBC";
152 else if (getProblem().hasVariable(bc_flux))
153 bc_type = "CoupledVarNeumannBC"; // not AD, but still perfect Jacobian
154 else if (getProblem().hasFunction(bc_flux))
155 bc_type = _use_ad ? "ADFunctionNeumannBC" : "FunctionNeumannBC";
156 else if (getProblem().hasPostprocessorValueByName(bc_flux))
157 bc_type = "PostprocessorNeumannBC";
158 else // this is AD, but we can mix AD and non-AD
159 bc_type = "FunctorNeumannBC";
160
161 // Get the parameters for the object type chosen and set the common parameters
162 InputParameters params = getFactory().getValidParams(bc_type);
163 params.set<NonlinearVariableName>("variable") = var_name;
164 params.set<std::vector<BoundaryName>>("boundary") = {_neumann_boundaries[s][i]};
165
166 // Set the flux parameter for the specific type of NeumannBC used
167 if (MooseUtils::parsesToReal(bc_flux))
168 params.set<Real>("value") = MooseUtils::convert<Real>(bc_flux);
169 else if (getProblem().hasVariable(bc_flux))
170 params.set<std::vector<VariableName>>("v") = {bc_flux};
171 else if (getProblem().hasFunction(bc_flux))
172 params.set<FunctionName>("function") = bc_flux;
173 else if (getProblem().hasPostprocessorValueByName(bc_flux))
174 params.set<PostprocessorName>("postprocessor") = bc_flux;
175 else
176 params.set<MooseFunctorName>("functor") = bc_flux;
177
178 getProblem().addBoundaryCondition(
179 bc_type, prefix() + var_name + "_neumann_bc_" + _neumann_boundaries[s][i], params);
180 }
181 }
182 }
183 if (isParamSetByUser("dirichlet_boundaries"))
184 {
185 const auto & boundary_values =
186 getParam<std::vector<std::vector<MooseFunctorName>>>("boundary_values");
187 for (const auto s : index_range(_species_names))
188 {
189 const auto & var_name = _species_names[s];
190 for (const auto i : index_range(_dirichlet_boundaries[s]))
191 {
192 const auto & bc_value = boundary_values[s][i];
193 // Select the boundary type based on the user parameters and what we know to be most
194 // efficient
195 std::string bc_type = "";
196 if (MooseUtils::parsesToReal(bc_value))
197 bc_type = _use_ad ? "ADDirichletBC" : "DirichletBC";
198 else if (getProblem().hasVariable(bc_value))
199 bc_type = _use_ad ? "ADMatchedValueBC" : "MatchedValueBC";
200 else if (getProblem().hasFunction(bc_value))
201 bc_type = _use_ad ? "ADFunctionDirichletBC" : "FunctionDirichletBC";
202 else if (getProblem().hasPostprocessorValueByName(bc_value))
203 bc_type = "PostprocessorDirichletBC";
204 else // this is AD, but we can mix AD and non-AD
205 bc_type = "FunctorDirichletBC";
206
207 InputParameters params = getFactory().getValidParams(bc_type);
208 params.set<NonlinearVariableName>("variable") = var_name;
209 params.set<std::vector<BoundaryName>>("boundary") = {_dirichlet_boundaries[s][i]};
210
211 // Set the flux parameter for the specific type of DirichletBC used
212 if (MooseUtils::parsesToReal(bc_value))
213 params.set<Real>("value") = MooseUtils::convert<Real>(bc_value);
214 else if (getProblem().hasVariable(bc_value))
215 params.set<std::vector<VariableName>>("v") = {bc_value};
216 else if (getProblem().hasFunction(bc_value))
217 params.set<FunctionName>("function") = bc_value;
218 else if (getProblem().hasPostprocessorValueByName(bc_value))
219 params.set<PostprocessorName>("postprocessor") = bc_value;
220 else
221 params.set<MooseFunctorName>("functor") = bc_value;
222
223 getProblem().addBoundaryCondition(
224 bc_type, prefix() + var_name + "_dirichlet_bc_" + _dirichlet_boundaries[s][i], params);
225 }
226 }
227 }
228}
FEProblemBase::hasPostprocessorValueByName
bool hasPostprocessorValueByName(const PostprocessorName &name) const
FEProblemBase::addBoundaryCondition
virtual void addBoundaryCondition(const std::string &bc_name, const std::string &name, InputParameters &parameters)
FEProblemBase::hasFunction
virtual bool hasFunction(const std::string &name, const THREAD_ID tid=0)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
PhysicsBase::isParamSetByUser
bool isParamSetByUser(const std::string &name) const
MultiSpeciesDiffusionPhysicsBase::_use_ad
const bool _use_ad
Whether to use automatic differentiation or not.
Definition MultiSpeciesDiffusionPhysicsBase.h:46
MultiSpeciesDiffusionPhysicsBase::_dirichlet_boundaries
const std::vector< std::vector< BoundaryName > > & _dirichlet_boundaries
Boundaries on which a Dirichlet boundary condition is applied. Outer indexing is variables.
Definition MultiSpeciesDiffusionPhysicsBase.h:43
MultiSpeciesDiffusionPhysicsBase::_species_names
const std::vector< VariableName > & _species_names
Name of the diffused variables.
Definition MultiSpeciesDiffusionPhysicsBase.h:37
MultiSpeciesDiffusionPhysicsBase::_neumann_boundaries
const std::vector< std::vector< BoundaryName > > & _neumann_boundaries
Boundaries on which a Neumann boundary condition is applied. Outer indexing is variables.
Definition MultiSpeciesDiffusionPhysicsBase.h:41
PhysicsBase::getProblem
virtual FEProblemBase & getProblem()
PhysicsBase::getFactory
Factory & getFactory()
PhysicsBase::prefix
std::string prefix() const
MooseUtils::parsesToReal
bool parsesToReal(const std::string &input, Real *parsed_real)
libMesh::index_range
auto index_range(const T &sizable)

◆ addFEKernels()

void MultiSpeciesDiffusionCG::addFEKernels ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 36 of file MultiSpeciesDiffusionCG.C.

37{
38 for (const auto s : index_range(_species_names))
39 {
40 const auto & var_name = _species_names[s];
41 // Diffusion term
42 if (isParamValid("diffusivity_matprops") || isParamValid("diffusivity_functors"))
43 {
44 // Select the kernel type based on the user parameters
45 std::string kernel_type;
46 if (isParamValid("diffusivity_matprops"))
47 kernel_type = _use_ad ? "ADMatDiffusion" : "MatDiffusion";
48 else if (isParamValid("diffusivity_functors"))
49 {
50 const auto & d = getParam<std::vector<MooseFunctorName>>("diffusivity_functors")[s];
51 if (getProblem().hasFunction(d))
52 kernel_type = "FunctionDiffusion";
53 else
54 paramError(
55 "diffusivity_functors", "No diffusion kernel implemented for the source type of", d);
56 }
57
58 InputParameters params = getFactory().getValidParams(kernel_type);
59 params.set<NonlinearVariableName>("variable") = var_name;
60 assignBlocks(params, _blocks);
61
62 // Transfer the diffusivity parameter from the Physics to the kernel
63 if (isParamValid("diffusivity_matprops"))
64 params.set<MaterialPropertyName>("diffusivity") =
65 getParam<std::vector<MaterialPropertyName>>("diffusivity_matprops")[s];
66 else if (isParamValid("diffusivity_functors"))
67 params.set<FunctionName>("function") =
68 getParam<std::vector<MooseFunctorName>>("diffusivity_functors")[s];
69
70 getProblem().addKernel(kernel_type, prefix() + var_name + "_diffusion", params);
71 }
72
73 // Source term
74 if (isParamValid("source_functors"))
75 {
76 // Select the kernel type based on the user parameters
77 std::string kernel_type;
78 const auto & sources = getParam<std::vector<MooseFunctorName>>("source_functors");
79 const auto & source = sources[s];
80 if (MooseUtils::parsesToReal(source) || getProblem().hasFunction(source) ||
81 getProblem().hasPostprocessorValueByName(source))
82 kernel_type = _use_ad ? "ADBodyForce" : "BodyForce";
83 else if (getProblem().hasVariable(source))
84 kernel_type = _use_ad ? "ADCoupledForce" : "CoupledForce";
85 else
86 paramError("source_functors",
87 "No kernel defined for a source term in CG for the type of '",
88 source,
89 "'");
90
91 InputParameters params = getFactory().getValidParams(kernel_type);
92 params.set<NonlinearVariableName>("variable") = var_name;
93 assignBlocks(params, _blocks);
94
95 // Transfer the source and coefficient parameter from the Physics to the kernel
96 const auto coefs = getParam<std::vector<Real>>("source_coefs");
97 const auto coef = coefs[s];
98 if (MooseUtils::parsesToReal(source))
99 params.set<Real>("value") = MooseUtils::convert<Real>(source) * coef;
100 else if (getProblem().hasFunction(source))
101 {
102 params.set<Real>("value") = coef;
103 params.set<FunctionName>("function") = source;
104 }
105 else if (getProblem().hasPostprocessorValueByName(source))
106 {
107 params.set<Real>("value") = coef;
108 params.set<PostprocessorName>("postprocessor") = source;
109 }
110 else
111 {
112 params.set<Real>("coef") = coef;
113 params.set<std::vector<VariableName>>("v") = {source};
114 }
115
116 getProblem().addKernel(kernel_type, prefix() + var_name + "_source", params);
117 }
118
119 // Time derivative term
120 if (shouldCreateTimeDerivative(var_name, _blocks, false))
121 {
122 const std::string kernel_type = _use_ad ? "ADTimeDerivative" : "TimeDerivative";
123 InputParameters params = getFactory().getValidParams(kernel_type);
124 params.set<NonlinearVariableName>("variable") = var_name;
125 assignBlocks(params, _blocks);
126 getProblem().addKernel(kernel_type, prefix() + var_name + "_time", params);
127 }
128 }
129}
FEProblemBase::addKernel
virtual void addKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
PhysicsBase::paramError
void paramError(const std::string &param, Args... args) const
PhysicsBase::getParam
const T & getParam(const std::string &name) const
PhysicsBase::isParamValid
bool isParamValid(const std::string &name) const
PhysicsBase::shouldCreateTimeDerivative
bool shouldCreateTimeDerivative(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const
PhysicsBase::assignBlocks
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ addInitialConditions()

void MultiSpeciesDiffusionPhysicsBase::addInitialConditions ( )
overrideprivatevirtualinherited

Add initial conditions for each diffused variable.

Reimplemented from PhysicsBase.

Definition at line 165 of file MultiSpeciesDiffusionPhysicsBase.C.

166{
167 InputParameters params = getFactory().getValidParams("FunctionIC");
168 assignBlocks(params, _blocks);
169
170 // always obey the user specification of initial conditions
171 // There are no default values, so no need to consider whether the app is restarting
172 for (const auto i : index_range(_species_names))
173 {
174 const auto & var_name = _species_names[i];
175 if (isParamValid("initial_conditions_species") &&
176 shouldCreateIC(var_name,
177 _blocks,
178 /*whether IC is a default*/ false,
179 /*error if already an IC*/ true))
180 {
181 params.set<VariableName>("variable") = var_name;
182 params.set<FunctionName>("function") =
183 getParam<std::vector<FunctionName>>("initial_conditions_species")[i];
184
185 getProblem().addInitialCondition("FunctionIC", prefix() + var_name + "_ic", params);
186 }
187 }
188}
FEProblemBase::addInitialCondition
virtual void addInitialCondition(const std::string &ic_name, const std::string &name, InputParameters &parameters)
PhysicsBase::shouldCreateIC
bool shouldCreateIC(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool ic_is_default_ic, const bool error_if_already_defined) const

◆ addPostprocessors()

void MultiSpeciesDiffusionPhysicsBase::addPostprocessors ( )
overrideprivatevirtualinherited

Add postprocessing of the fluxes.

Reimplemented from PhysicsBase.

Definition at line 124 of file MultiSpeciesDiffusionPhysicsBase.C.

125{
126 for (const auto i : index_range(_species_names))
127 {
128 const auto & var_name = _species_names[i];
129 for (const auto & boundary_name :
130 getParam<std::vector<BoundaryName>>("compute_diffusive_fluxes_on"))
131 {
132 // Create the boundary integration of the flux
133 const std::string pp_type =
134 _use_ad ? "ADSideDiffusiveFluxIntegral" : "SideDiffusiveFluxIntegral";
135 auto params = _factory.getValidParams(pp_type);
136 params.set<std::vector<VariableName>>("variable") = {var_name};
137 // FE variables require matprops for this postprocessor at the moment
138 if (isParamValid("diffusivity_matprops"))
139 params.set<MaterialPropertyName>("diffusivity") =
140 getParam<std::vector<MaterialPropertyName>>("diffusivity_matprops")[i];
141 // FV variables require functors
142 else if (isParamValid("diffusivity_functors"))
143 params.set<MooseFunctorName>("functor_diffusivity") =
144 getParam<std::vector<MooseFunctorName>>("diffusivity_functors")[i];
145 else
146 mooseError("No diffusivity parameter specified");
147 params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
148 // Default to maximum computation
149 params.set<ExecFlagEnum>("execute_on") = {
150 EXEC_INITIAL, EXEC_TIMESTEP_END, EXEC_NONLINEAR, EXEC_LINEAR};
151 getProblem().addPostprocessor(
152 pp_type, prefix() + "diffusive_flux_" + var_name + "_" + boundary_name, params);
153 }
154 }
155}
EXEC_TIMESTEP_END
const ExecFlagType EXEC_TIMESTEP_END
EXEC_INITIAL
const ExecFlagType EXEC_INITIAL
EXEC_LINEAR
const ExecFlagType EXEC_LINEAR
EXEC_NONLINEAR
const ExecFlagType EXEC_NONLINEAR
FEProblemBase::addPostprocessor
virtual void addPostprocessor(const std::string &pp_name, const std::string &name, InputParameters &parameters)
PhysicsBase::mooseError
void mooseError(Args &&... args) const
PhysicsBase::_factory
Factory & _factory

◆ addPreconditioning()

void MultiSpeciesDiffusionPhysicsBase::addPreconditioning ( )
overrideprivatevirtualinherited

Add default preconditioning options.

Reimplemented from PhysicsBase.

Definition at line 109 of file MultiSpeciesDiffusionPhysicsBase.C.

110{
111 // Use a multi-grid method, known to work for elliptic problems such as diffusion
112 if (_preconditioning == "default")
113 {
114 // We only pass petsc options as that's all that's needed to set up the preconditioner
115 const auto option_pair1 =
116 std::make_pair<MooseEnumItem, std::string>(MooseEnumItem("-pc_type"), "hypre");
117 const auto option_pair2 =
118 std::make_pair<MooseEnumItem, std::string>(MooseEnumItem("-pc_hypre_type"), "boomeramg");
119 addPetscPairsToPetscOptions({option_pair1, option_pair2});
120 }
121}
PhysicsBase::addPetscPairsToPetscOptions
void addPetscPairsToPetscOptions(const std::vector< std::pair< MooseEnumItem, std::string > > &petsc_pair_options)
PhysicsBase::_preconditioning
const MooseEnum & _preconditioning

◆ addSolverVariables()

void MultiSpeciesDiffusionCG::addSolverVariables ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 231 of file MultiSpeciesDiffusionCG.C.

232{
233 for (const auto & var_name : _species_names)
234 {
235 // If the variable was added outside the Physics
236 if (variableExists(var_name, /*error_if_aux*/ true))
237 {
238 if (isParamValid("variable_order"))
239 paramError("variable_order",
240 "Cannot specify the variable order if variable " + var_name +
241 " is defined outside the Physics block");
242 else
243 continue;
244 }
245
246 const std::string variable_type = "MooseVariable";
247 InputParameters params = getFactory().getValidParams(variable_type);
248 params.set<MooseEnum>("order") = getParam<MooseEnum>("variable_order");
249 assignBlocks(params, _blocks);
250 params.set<SolverSystemName>("solver_sys") = getSolverSystem(var_name);
251
252 getProblem().addVariable(variable_type, var_name, params);
253 }
254}
FEProblemBase::addVariable
virtual void addVariable(const std::string &var_type, const std::string &var_name, InputParameters &params)
PhysicsBase::variableExists
bool variableExists(const VariableName &var_name, bool error_if_aux) const
PhysicsBase::getSolverSystem
const SolverSystemName & getSolverSystem(unsigned int variable_index) const

◆ validParams()

InputParameters MultiSpeciesDiffusionCG::validParams ( )
static

Definition at line 20 of file MultiSpeciesDiffusionCG.C.

21{
22 InputParameters params = MultiSpeciesDiffusionPhysicsBase::validParams();
23 params.addClassDescription("Discretizes diffusion equations for several species with the "
24 "continuous Galerkin finite element method");
25 params.transferParam<MooseEnum>(MooseVariableBase::validParams(), "order", "variable_order");
26
27 return params;
28}
InputParameters::transferParam
void transferParam(const InputParameters &source_param, const std::string &name, const std::string &new_name="", const std::string &new_description="")
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
MooseVariableBase::validParams
static InputParameters validParams()

Member Data Documentation

◆ _dirichlet_boundaries

const std::vector<std::vector<BoundaryName> >& MultiSpeciesDiffusionPhysicsBase::_dirichlet_boundaries
protectedinherited

Boundaries on which a Dirichlet boundary condition is applied. Outer indexing is variables.

Definition at line 43 of file MultiSpeciesDiffusionPhysicsBase.h.

Referenced by addFEBCs().

◆ _neumann_boundaries

const std::vector<std::vector<BoundaryName> >& MultiSpeciesDiffusionPhysicsBase::_neumann_boundaries
protectedinherited

Boundaries on which a Neumann boundary condition is applied. Outer indexing is variables.

Definition at line 41 of file MultiSpeciesDiffusionPhysicsBase.h.

Referenced by addFEBCs().

◆ _num_species

const unsigned int MultiSpeciesDiffusionPhysicsBase::_num_species
protectedinherited

Number of species.

Definition at line 39 of file MultiSpeciesDiffusionPhysicsBase.h.

◆ _species_names

const std::vector<VariableName>& MultiSpeciesDiffusionPhysicsBase::_species_names
protectedinherited

Name of the diffused variables.

Definition at line 37 of file MultiSpeciesDiffusionPhysicsBase.h.

Referenced by addFEBCs(), addFEKernels(), MultiSpeciesDiffusionPhysicsBase::addInitialConditions(), MultiSpeciesDiffusionPhysicsBase::addPostprocessors(), addSolverVariables(), and MultiSpeciesDiffusionPhysicsBase::MultiSpeciesDiffusionPhysicsBase().

◆ _use_ad

const bool MultiSpeciesDiffusionPhysicsBase::_use_ad
protectedinherited

Whether to use automatic differentiation or not.

Definition at line 46 of file MultiSpeciesDiffusionPhysicsBase.h.

Referenced by addFEBCs(), addFEKernels(), and MultiSpeciesDiffusionPhysicsBase::addPostprocessors().

The documentation for this class was generated from the following files:
Generated on Fri Sep 11 2026 20:38:48 for https://mooseframework.inl.gov by doxygen 1.9.8