https://mooseframework.inl.gov
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 | List of all members
MultiSpeciesDiffusionPhysicsBase Class Reference

Base class to host all common parameters and attributes of Physics actions to solve the diffusion equation for multiple species. More...

#include <MultiSpeciesDiffusionPhysicsBase.h>

Inheritance diagram for MultiSpeciesDiffusionPhysicsBase:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 MultiSpeciesDiffusionPhysicsBase (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
 
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
 
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
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
PerfGraph & perfGraph ()
 
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 ()
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

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 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
 
bool addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
 
void associateWithParameter (const std::string &param_name, InputParameters &params) const
 
void associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
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. More...
 
const unsigned int _num_species
 Number of species. More...
 
const std::vector< std::vector< BoundaryName > > & _neumann_boundaries
 Boundaries on which a Neumann boundary condition is applied. Outer indexing is variables. More...
 
const std::vector< std::vector< BoundaryName > > & _dirichlet_boundaries
 Boundaries on which a Dirichlet boundary condition is applied. Outer indexing is variables. More...
 
const bool _use_ad
 Whether to use automatic differentiation or not. More...
 
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
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Private Member Functions

virtual void addPreconditioning () override
 Add default preconditioning options. More...
 
virtual void addPostprocessors () override
 Add postprocessing of the fluxes. More...
 
virtual void addInitialConditions () override
 Add initial conditions for each diffused variable. More...
 

Detailed Description

Base class to host all common parameters and attributes of Physics actions to solve the diffusion equation for multiple species.

Definition at line 26 of file MultiSpeciesDiffusionPhysicsBase.h.

Constructor & Destructor Documentation

◆ MultiSpeciesDiffusionPhysicsBase()

MultiSpeciesDiffusionPhysicsBase::MultiSpeciesDiffusionPhysicsBase ( const InputParameters &  parameters)

Definition at line 76 of file MultiSpeciesDiffusionPhysicsBase.C.

78  : PhysicsBase(parameters),
79  _species_names(getParam<std::vector<VariableName>>("species")),
80  _num_species(_species_names.size()),
81  _neumann_boundaries(getParam<std::vector<std::vector<BoundaryName>>>("neumann_boundaries")),
82  _dirichlet_boundaries(getParam<std::vector<std::vector<BoundaryName>>>("dirichlet_boundaries")),
83  _use_ad(getParam<bool>("use_automatic_differentiation"))
84 {
85  // Keep track of variables
86  for (const auto & var_name : _species_names)
87  saveSolverVariableName(var_name);
88 
89  // Parameter checking
90  checkTwoDVectorParamsSameLength<BoundaryName, MooseFunctorName>("neumann_boundaries",
91  "boundary_fluxes");
92  checkTwoDVectorParamsSameLength<BoundaryName, MooseFunctorName>("dirichlet_boundaries",
93  "boundary_values");
94  checkTwoDVectorParamsNoRespectiveOverlap<BoundaryName>(
95  {"neumann_boundaries", "dirichlet_boundaries"});
96  if (isParamSetByUser("source_coefs"))
97  checkParamsBothSetOrNotSet("source_functors", "source_coefs");
98  if (isParamValid("source_functors"))
99  checkVectorParamsSameLength<VariableName, MooseFunctorName>("species", "source_functors");
100  if (isParamValid("initial_conditions_species"))
101  checkVectorParamsSameLength<VariableName, FunctionName>("species",
102  "initial_conditions_species");
103 
104  addRequiredPhysicsTask("add_preconditioning");
105  addRequiredPhysicsTask("add_ic");
106 }
PhysicsBase::addRequiredPhysicsTask
void addRequiredPhysicsTask(const std::string &task)
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::checkParamsBothSetOrNotSet
void checkParamsBothSetOrNotSet(const std::string &param1, const std::string &param2) const
PhysicsBase::isParamValid
bool isParamValid(const std::string &name) const
PhysicsBase::PhysicsBase
PhysicsBase(const InputParameters &parameters)
PhysicsBase::getParam
const T & getParam(const std::string &name) const
MultiSpeciesDiffusionPhysicsBase::_species_names
const std::vector< VariableName > & _species_names
Name of the diffused variables.
Definition: MultiSpeciesDiffusionPhysicsBase.h:37
PhysicsBase::isParamSetByUser
bool isParamSetByUser(const std::string &nm) const
MultiSpeciesDiffusionPhysicsBase::_num_species
const unsigned int _num_species
Number of species.
Definition: MultiSpeciesDiffusionPhysicsBase.h:39
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
PhysicsBase::parameters
const InputParameters & parameters() const
MultiSpeciesDiffusionPhysicsBase::_use_ad
const bool _use_ad
Whether to use automatic differentiation or not.
Definition: MultiSpeciesDiffusionPhysicsBase.h:46
PhysicsBase::saveSolverVariableName
void saveSolverVariableName(const VariableName &var_name)

Member Function Documentation

◆ addComponent()

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

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 }
NS::component
static const std::string component
Definition: NS.h:153
PhysicsBase::_blocks
std::vector< SubdomainName > _blocks

◆ addInitialConditions()

void MultiSpeciesDiffusionPhysicsBase::addInitialConditions ( )
overrideprivatevirtual

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 }
PhysicsBase::prefix
std::string prefix() const
PhysicsBase::assignBlocks
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
PhysicsBase::getFactory
Factory & getFactory()
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
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
PhysicsBase::_blocks
std::vector< SubdomainName > _blocks
PhysicsBase::isParamValid
bool isParamValid(const std::string &name) const
FEProblemBase::addInitialCondition
virtual void addInitialCondition(const std::string &ic_name, const std::string &name, InputParameters &parameters)
PhysicsBase::getProblem
virtual FEProblemBase & getProblem()
PhysicsBase::getParam
const T & getParam(const std::string &name) const
MultiSpeciesDiffusionPhysicsBase::_species_names
const std::vector< VariableName > & _species_names
Name of the diffused variables.
Definition: MultiSpeciesDiffusionPhysicsBase.h:37
index_range
auto index_range(const T &sizable)

◆ addPostprocessors()

void MultiSpeciesDiffusionPhysicsBase::addPostprocessors ( )
overrideprivatevirtual

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 }
PhysicsBase::prefix
std::string prefix() const
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
EXEC_TIMESTEP_END
const ExecFlagType EXEC_TIMESTEP_END
PhysicsBase::isParamValid
bool isParamValid(const std::string &name) const
PhysicsBase::_factory
Factory & _factory
PhysicsBase::getProblem
virtual FEProblemBase & getProblem()
FEProblemBase::addPostprocessor
virtual void addPostprocessor(const std::string &pp_name, const std::string &name, InputParameters &parameters)
PhysicsBase::getParam
const T & getParam(const std::string &name) const
EXEC_LINEAR
const ExecFlagType EXEC_LINEAR
MultiSpeciesDiffusionPhysicsBase::_species_names
const std::vector< VariableName > & _species_names
Name of the diffused variables.
Definition: MultiSpeciesDiffusionPhysicsBase.h:37
EXEC_NONLINEAR
const ExecFlagType EXEC_NONLINEAR
PhysicsBase::mooseError
void mooseError(Args &&... args) const
MultiSpeciesDiffusionPhysicsBase::_use_ad
const bool _use_ad
Whether to use automatic differentiation or not.
Definition: MultiSpeciesDiffusionPhysicsBase.h:46
index_range
auto index_range(const T &sizable)
EXEC_INITIAL
const ExecFlagType EXEC_INITIAL

◆ addPreconditioning()

void MultiSpeciesDiffusionPhysicsBase::addPreconditioning ( )
overrideprivatevirtual

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

◆ validParams()

InputParameters MultiSpeciesDiffusionPhysicsBase::validParams ( )
static

Definition at line 18 of file MultiSpeciesDiffusionPhysicsBase.C.

Referenced by MultiSpeciesDiffusionCG::validParams().

19 {
20  InputParameters params = PhysicsBase::validParams();
21  params.addClassDescription(
22  "Base class for creating a diffusion equation for multiple diffused species");
23 
24  params.addRequiredParam<std::vector<VariableName>>("species", "Species being diffused");
25 
26  // Diffusivity
27  params.addParam<std::vector<MaterialPropertyName>>(
28  "diffusivity_matprops",
29  "Material properties defining the diffusion coefficient for each species");
30  params.addParam<std::vector<MooseFunctorName>>(
31  "diffusivity_functors", "Functors specifying the diffusivity for each species");
32 
33  // Source term
34  params.addParam<std::vector<MooseFunctorName>>(
35  "source_functors", "Source terms in the diffusion problem for each species");
36  params.addParam<std::vector<Real>>("source_coefs", {1}, "Coefficient multiplying the source");
37 
38  // Boundary conditions
39  params.addParam<std::vector<std::vector<BoundaryName>>>(
40  "neumann_boundaries", {}, "Boundaries on which to apply a diffusive flux for each species");
41  params.addParam<std::vector<std::vector<BoundaryName>>>(
42  "dirichlet_boundaries", {}, "Boundaries on which to apply a fixed value for each species");
43  params.addParam<std::vector<std::vector<MooseFunctorName>>>(
44  "boundary_fluxes",
45  {},
46  "Functors to compute the diffusive flux on each Neumann boundary for each species");
47  params.addParam<std::vector<std::vector<MooseFunctorName>>>(
48  "boundary_values",
49  {},
50  "Functors to compute the diffusive flux on each Dirichlet boundary for each species");
51  params.addParamNamesToGroup("neumann_boundaries dirichlet_boundaries boundary_fluxes "
52  "boundary_values",
53  "Boundary conditions");
54 
55  // Initial conditions
56  params.addParam<std::vector<FunctionName>>(
57  "initial_conditions_species", "Functions describing the initial conditions for the species");
58 
59  // Postprocessing
60  params.addParam<std::vector<BoundaryName>>(
61  "compute_diffusive_fluxes_on", {}, "Surfaces to compute the diffusive flux on");
62 
63  // Preconditioning is implemented so let's use it by default
64  MooseEnum pc_options("default defer", "default");
65  params.addParam<MooseEnum>(
66  "preconditioning", pc_options, "Which preconditioning to use for this Physics");
67 
68  params.addParam<bool>(
69  "use_automatic_differentiation",
70  true,
71  "Whether to use automatic differentiation for all the terms in the equation");
72 
73  return params;
74 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
PhysicsBase::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
InputParameters::addParamNamesToGroup
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)

Member Data Documentation

◆ _dirichlet_boundaries

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

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

Definition at line 43 of file MultiSpeciesDiffusionPhysicsBase.h.

Referenced by MultiSpeciesDiffusionCG::addFEBCs().

◆ _neumann_boundaries

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

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

Definition at line 41 of file MultiSpeciesDiffusionPhysicsBase.h.

Referenced by MultiSpeciesDiffusionCG::addFEBCs().

◆ _num_species

const unsigned int MultiSpeciesDiffusionPhysicsBase::_num_species
protected

Number of species.

Definition at line 39 of file MultiSpeciesDiffusionPhysicsBase.h.

◆ _species_names

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

Name of the diffused variables.

Definition at line 37 of file MultiSpeciesDiffusionPhysicsBase.h.

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

◆ _use_ad

const bool MultiSpeciesDiffusionPhysicsBase::_use_ad
protected

Whether to use automatic differentiation or not.

Definition at line 46 of file MultiSpeciesDiffusionPhysicsBase.h.

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

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:49:00 for https://mooseframework.inl.gov by   doxygen 1.8.14