https://mooseframework.inl.gov
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
DisplacedSystem Class Reference

#include <DisplacedSystem.h>

Inheritance diagram for DisplacedSystem:
[legend]

Public Member Functions

 DisplacedSystem (DisplacedSystem &&)=delete
 
DisplacedSystemoperator= (DisplacedSystem &&)=delete
 
 DisplacedSystem (DisplacedProblem &problem, FEProblemBase &fe_problem, SystemBase &undisplaced_system, const std::string &name, Moose::VarKindType var_kind)
 
virtual ~DisplacedSystem ()
 
virtual NumericVector< Number > & getVector (TagID tag_id) override
 Get a raw NumericVector by tag. More...
 
virtual const NumericVector< Number > & getVector (TagID tag_id) const override
 
virtual TagID residualVectorTag () const override
 
virtual TagID systemMatrixTag () const override
 Return the Matrix Tag ID for System. More...
 
virtual TagID timeVectorTag () const override
 Ideally, we should not need this API. More...
 
virtual TagID nonTimeVectorTag () const override
 
virtual std::set< TagIDdefaultVectorTags () const override
 Get the default vector tags associated with this system. More...
 
virtual std::set< TagIDdefaultMatrixTags () const override
 Get the default matrix tags associted with this system. More...
 
virtual void associateVectorToTag (NumericVector< Number > &vec, TagID tag) override
 Associate a vector for a given tag. More...
 
virtual void disassociateVectorFromTag (NumericVector< Number > &vec, TagID tag) override
 Disassociate a given vector from a given tag. More...
 
virtual void disassociateVectorFromTag (TagID tag) override
 Disassociate any vector that is associated with a given tag. More...
 
virtual void disassociateDefaultVectorTags () override
 Disassociate the vectors associated with the default vector tags of this system. More...
 
virtual void associateMatrixToTag (libMesh::SparseMatrix< Number > &matrix, TagID tag) override
 Associate a matrix to a tag. More...
 
virtual void disassociateMatrixFromTag (libMesh::SparseMatrix< Number > &matrix, TagID tag) override
 Disassociate a matrix from a tag. More...
 
virtual void disassociateMatrixFromTag (TagID tag) override
 Disassociate any matrix that is associated with a given tag. More...
 
virtual void disassociateDefaultMatrixTags () override
 Disassociate the matrices associated with the default matrix tags of this system. More...
 
virtual NumericVector< Number > & getVector (const std::string &name) override
 Get a raw NumericVector by name. More...
 
virtual const NumericVector< Number > & getVector (const std::string &name) const override
 
virtual NumericVector< Number > & serializedSolution () override
 Returns a reference to a serialized version of the solution vector for this subproblem. More...
 
const NumericVector< Number > *const & currentSolution () const override
 The solution vector that is currently being operated on. More...
 
NumericVector< Number > * solutionPreviousNewton () override
 
const NumericVector< Number > * solutionPreviousNewton () const override
 
NumericVector< Number > * solutionUDot () override
 
NumericVector< Number > * solutionUDotDot () override
 
NumericVector< Number > * solutionUDotOld () override
 
NumericVector< Number > * solutionUDotDotOld () override
 
const NumericVector< Number > * solutionUDot () const override
 
const NumericVector< Number > * solutionUDotDot () const override
 
const NumericVector< Number > * solutionUDotOld () const override
 
const NumericVector< Number > * solutionUDotDotOld () const override
 
virtual std::vector< Number > & duDotDus () override
 
virtual NumberduDotDotDu () override
 
virtual const NumberduDotDu (unsigned int var_num=0) const override
 
virtual const NumberduDotDotDu () const override
 
virtual void addDotVectors () override
 Add u_dot, u_dotdot, u_dot_old and u_dotdot_old vectors if requested by the time integrator. More...
 
virtual NumericVector< Number > & residualCopy () override
 Return the residual copy from the NonlinearSystem. More...
 
virtual NumericVector< Number > & residualGhosted () override
 
virtual void augmentSendList (std::vector< dof_id_type > &send_list) override
 Will modify the send_list to add all of the extra ghosted dofs for this system. More...
 
virtual void augmentSparsity (libMesh::SparsityPattern::Graph &, std::vector< dof_id_type > &, std::vector< dof_id_type > &) override
 This is an empty function since the displaced system doesn't have a matrix! All sparsity pattern modification will be taken care of by the undisplaced system directly. More...
 
virtual void addVariableToZeroOnResidual (std::string var_name) override
 Adds this variable to the list of variables to be zeroed during each residual evaluation. More...
 
virtual void addVariableToZeroOnJacobian (std::string var_name) override
 Adds this variable to the list of variables to be zeroed during each jacobian evaluation. More...
 
virtual void zeroVariables (std::vector< std::string > &vars_to_be_zeroed) override
 Zero out the solution for the list of variables passed in. More...
 
virtual bool hasVector (TagID tag_id) const override
 Check if the tagged vector exists in the system. More...
 
virtual bool hasMatrix (TagID tag_id) const override
 Check if the tagged matrix exists in the system. More...
 
virtual void initSolutionState () override
 Initializes the solution state. More...
 
virtual NumericVector< Number > & solutionState (const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time) override
 Get a state of the solution (0 = current, 1 = old, 2 = older, etc). More...
 
virtual const NumericVector< Number > & solutionState (const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time) const override
 Get a state of the solution (0 = current, 1 = old, 2 = older, etc). More...
 
virtual void needSolutionState (const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time) override
 Registers that the solution state state is needed. More...
 
virtual bool hasSolutionState (const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time) const override
 Whether or not the system has the solution state (0 = current, 1 = old, 2 = older, etc). More...
 
virtual libMesh::SparseMatrix< Number > & getMatrix (TagID tag) override
 Get a raw SparseMatrix. More...
 
virtual const libMesh::SparseMatrix< Number > & getMatrix (TagID tag) const override
 Get a raw SparseMatrix. More...
 
virtual libMesh::Systemsys ()
 
virtual System & system () override
 Get the reference to the libMesh system. More...
 
virtual const System & system () const override
 
virtual void compute (ExecFlagType) override
 Compute time derivatives, auxiliary variables, etc. More...
 
unsigned int number () const
 Gets the number of this system. More...
 
MooseMeshmesh ()
 
const MooseMeshmesh () const
 
SubProblemsubproblem ()
 
const SubProblemsubproblem () const
 
FEProblemBasefeProblem ()
 
const FEProblemBasefeProblem () const
 
void applyScalingFactors (const std::vector< Real > &inverse_scaling_factors)
 Applies scaling factors to the system's variables. More...
 
bool computingScalingJacobian () const
 Whether we are computing an initial Jacobian for automatic variable scaling. More...
 
bool automaticScaling () const
 Getter for whether we are performing automatic scaling. More...
 
void automaticScaling (bool automatic_scaling)
 Setter for whether we are performing automatic scaling. More...
 
void setVerboseFlag (const bool &verbose)
 Sets the verbose flag. More...
 
virtual libMesh::DofMapdofMap ()
 Gets writeable reference to the dof map. More...
 
virtual const libMesh::DofMapdofMap () const
 Gets const reference to the dof map. More...
 
virtual void preInit ()
 This is called prior to the libMesh system has been init'd. More...
 
virtual void postInit ()
 
virtual void reinit ()
 Reinitialize the system when the degrees of freedom in this system have changed. More...
 
virtual void initializeObjects ()
 Called only once, just before the solve begins so objects can do some precalculations. More...
 
void update ()
 Update the system (doing libMesh magic) More...
 
virtual void solve ()
 Solve the system (using libMesh magic) More...
 
virtual void copyOldSolutions ()
 Shifts the solutions backwards in time. More...
 
virtual void copyPreviousNonlinearSolutions ()
 Shifts the solutions backwards in nonlinear iteration history. More...
 
virtual void restoreSolutions ()
 Restore current solutions (call after your solve failed) More...
 
NumericVector< Number > & solution ()
 
const NumericVector< Number > & solution () const
 
NumericVector< Number > & solutionOld ()
 
const NumericVector< Number > & solutionOld () const
 
NumericVector< Number > & solutionOlder ()
 
const NumericVector< Number > & solutionOlder () const
 
virtual void saveOldSolutions ()
 Save the old and older solutions. More...
 
virtual void restoreOldSolutions ()
 Restore the old and older solutions when the saved solutions present. More...
 
bool hasVector (const std::string &tag_name) const
 Check if the named vector exists in the system. More...
 
virtual void activeAllMatrixTags ()
 Make all exsiting matrices ative. More...
 
virtual void activeMatrixTag (TagID tag)
 Active a matrix for tag. More...
 
virtual bool matrixTagActive (TagID tag) const
 If or not a matrix tag is active. More...
 
virtual void deactiveMatrixTag (TagID tag)
 deactive a matrix for tag More...
 
virtual void deactiveAllMatrixTags ()
 Make matrices inactive. More...
 
void closeTaggedMatrices (const std::set< TagID > &tags)
 Close all matrices associated the tags. More...
 
void flushTaggedMatrices (const std::set< TagID > &tags)
 flushes all matrices associated to tags. More...
 
virtual void addVariable (const std::string &var_type, const std::string &var_name, InputParameters &parameters)
 Canonical method for adding a variable. More...
 
virtual bool isArrayVariable (const std::string &var_name) const
 If a variable is an array variable. More...
 
virtual bool isScalarVariable (unsigned int var_name) const
 
MooseVariableFieldBasegetVariable (THREAD_ID tid, const std::string &var_name) const
 Gets a reference to a variable of with specified name. More...
 
MooseVariableFieldBasegetVariable (THREAD_ID tid, unsigned int var_number) const
 Gets a reference to a variable with specified number. More...
 
template<typename T >
MooseVariableFE< T > & getFieldVariable (THREAD_ID tid, const std::string &var_name)
 Gets a reference to a variable of with specified name. More...
 
template<typename T >
MooseVariableFE< T > & getFieldVariable (THREAD_ID tid, unsigned int var_number)
 Gets a reference to a variable with specified number. More...
 
template<typename T >
MooseVariableField< T > & getActualFieldVariable (THREAD_ID tid, const std::string &var_name)
 Returns a field variable pointer - this includes finite volume variables. More...
 
template<typename T >
MooseVariableField< T > & getActualFieldVariable (THREAD_ID tid, unsigned int var_number)
 Returns a field variable pointer - this includes finite volume variables. More...
 
template<typename T >
MooseVariableFV< T > & getFVVariable (THREAD_ID tid, const std::string &var_name)
 Return a finite volume variable. More...
 
virtual MooseVariableScalargetScalarVariable (THREAD_ID tid, const std::string &var_name) const
 Gets a reference to a scalar variable with specified number. More...
 
virtual MooseVariableScalargetScalarVariable (THREAD_ID tid, unsigned int var_number) const
 Gets a reference to a variable with specified number. More...
 
virtual const std::set< SubdomainID > * getVariableBlocks (unsigned int var_number)
 Get the block where a variable of this system is defined. More...
 
virtual unsigned int nVariables () const
 Get the number of variables in this system. More...
 
unsigned int nFieldVariables () const
 Get the number of field variables in this system. More...
 
unsigned int nFVVariables () const
 Get the number of finite volume variables in this system. More...
 
std::size_t getMaxVarNDofsPerElem () const
 Gets the maximum number of dofs used by any one variable on any one element. More...
 
std::size_t getMaxVarNDofsPerNode () const
 Gets the maximum number of dofs used by any one variable on any one node. More...
 
void assignMaxVarNDofsPerElem (std::size_t max_dofs)
 assign the maximum element dofs More...
 
void assignMaxVarNDofsPerNode (std::size_t max_dofs)
 assign the maximum node dofs More...
 
virtual void zeroVariablesForResidual ()
 Zero out the solution for the variables that were registered as needing to have their solutions zeroed on out on residual evaluation by a call to addVariableToZeroOnResidual() More...
 
virtual void zeroVariablesForJacobian ()
 Zero out the solution for the variables that were registered as needing to have their solutions zeroed on out on Jacobian evaluation by a call to addVariableToZeroOnResidual() More...
 
virtual libMesh::Order getMinQuadratureOrder ()
 Get minimal quadrature order needed for integrating variables in this system. More...
 
virtual void prepare (THREAD_ID tid)
 Prepare the system for use. More...
 
virtual void prepareFace (THREAD_ID tid, bool resize_data)
 Prepare the system for use on sides. More...
 
virtual void prepareNeighbor (THREAD_ID tid)
 Prepare the system for use. More...
 
virtual void prepareLowerD (THREAD_ID tid)
 Prepare the system for use for lower dimensional elements. More...
 
virtual void reinitElem (const Elem *elem, THREAD_ID tid)
 Reinit an element assembly info. More...
 
virtual void reinitElemFace (const Elem *elem, unsigned int side, THREAD_ID tid)
 Reinit assembly info for a side of an element. More...
 
virtual void reinitNeighborFace (const Elem *elem, unsigned int side, THREAD_ID tid)
 Compute the values of the variables at all the current points. More...
 
virtual void reinitNeighbor (const Elem *elem, THREAD_ID tid)
 Compute the values of the variables at all the current points. More...
 
virtual void reinitLowerD (THREAD_ID tid)
 Compute the values of the variables on the lower dimensional element. More...
 
virtual void reinitNode (const Node *node, THREAD_ID tid)
 Reinit nodal assembly info. More...
 
virtual void reinitNodeFace (const Node *node, BoundaryID bnd_id, THREAD_ID tid)
 Reinit nodal assembly info on a face. More...
 
virtual void reinitNodes (const std::vector< dof_id_type > &nodes, THREAD_ID tid)
 Reinit variables at a set of nodes. More...
 
virtual void reinitNodesNeighbor (const std::vector< dof_id_type > &nodes, THREAD_ID tid)
 Reinit variables at a set of neighbor nodes. More...
 
virtual void reinitScalars (THREAD_ID tid, bool reinit_for_derivative_reordering=false)
 Reinit scalar varaibles. More...
 
virtual void addVariableToCopy (const std::string &dest_name, const std::string &source_name, const std::string &timestep)
 Add info about variable that will be copied. More...
 
const std::vector< MooseVariableFieldBase * > & getVariables (THREAD_ID tid)
 
const std::vector< MooseVariableScalar * > & getScalarVariables (THREAD_ID tid)
 
const std::set< SubdomainID > & getSubdomainsForVar (unsigned int var_number) const
 
const std::set< SubdomainID > & getSubdomainsForVar (const std::string &var_name) const
 Get the block where a variable of this system is defined. More...
 
void removeVector (const std::string &name)
 Remove a vector from the system with the given name. More...
 
void removeVector (TagID tag_id)
 Remove a solution length vector from the system with the specified TagID. More...
 
NumericVector< Number > & addVector (const std::string &vector_name, const bool project, const libMesh::ParallelType type)
 Adds a solution length vector to the system. More...
 
NumericVector< Number > & addVector (TagID tag, const bool project, const libMesh::ParallelType type)
 Adds a solution length vector to the system with the specified TagID. More...
 
void closeTaggedVector (const TagID tag)
 Close vector with the given tag. More...
 
void closeTaggedVectors (const std::set< TagID > &tags)
 Close all vectors for given tags. More...
 
void zeroTaggedVector (const TagID tag)
 Zero vector with the given tag. More...
 
void zeroTaggedVectors (const std::set< TagID > &tags)
 Zero all vectors for given tags. More...
 
void setVariableGlobalDoFs (const std::string &var_name)
 set all the global dof indices for a variable More...
 
const std::vector< dof_id_type > & getVariableGlobalDoFs ()
 Get the global dof indices of a variable, this needs to be called after the indices have been set by setVariableGlobalDoFs More...
 
libMesh::SparseMatrix< Number > & addMatrix (TagID tag)
 Adds a matrix with a given tag. More...
 
void removeMatrix (TagID tag)
 Removes a matrix with a given tag. More...
 
virtual const std::string & name () const
 
const std::vector< VariableName > & getVariableNames () const
 
void getStandardFieldVariableNames (std::vector< VariableName > &std_field_variables) const
 
unsigned int getMaxVariableNumber () const
 Returns the maximum number of all variables on the system. More...
 
virtual void computeVariables (const NumericVector< Number > &)
 
void copyVars (libMesh::ExodusII_IO &io)
 
virtual void copySolutionsBackwards ()
 Copy current solution into old and older. More...
 
void addTimeIntegrator (const std::string &type, const std::string &name, InputParameters &parameters)
 
bool hasVarCopy () const
 Whether or not there are variables to be restarted from an Exodus mesh file. More...
 
void addScalingVector ()
 Add the scaling factor vector to the system. More...
 
bool solutionStatesInitialized () const
 Whether or not the solution states have been initialized via initSolutionState() More...
 
virtual void initialSetup ()
 Setup Functions. More...
 
virtual void timestepSetup ()
 
virtual void customSetup (const ExecFlagType &exec_type)
 
virtual void subdomainSetup ()
 
virtual void residualSetup ()
 
virtual void jacobianSetup ()
 
void clearAllDofIndices ()
 Clear all dof indices from moose variables. More...
 
void setActiveVariableCoupleableVectorTags (const std::set< TagID > &vtags, THREAD_ID tid)
 Set the active vector tags for the variables. More...
 
void setActiveScalarVariableCoupleableVectorTags (const std::set< TagID > &vtags, THREAD_ID tid)
 Set the active vector tags for the scalar variables. More...
 
Moose::VarKindType varKind () const
 
const std::vector< std::unique_ptr< NumericVector< Number > > > & gradientContainer () const
 Reference to the container vector which hold gradients at dofs (if it can be interpreted). More...
 
void copyTimeIntegrators (const SystemBase &other_sys)
 Copy time integrators from another system. More...
 
const TimeIntegratorgetTimeIntegrator (const unsigned int var_num) const
 Retrieve the time integrator that integrates the given variable's equation. More...
 
const TimeIntegratorqueryTimeIntegrator (const unsigned int var_num) const
 Retrieve the time integrator that integrates the given variable's equation. More...
 
const std::vector< std::shared_ptr< TimeIntegrator > > & getTimeIntegrators ()
 
std::string prefix () const
 
const Parallel::Communicatorcomm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
virtual bool hasVariable (const std::string &var_name) const
 Query a system for a variable. More...
 
virtual bool hasScalarVariable (const std::string &var_name) const
 

Public Attributes

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

Protected Member Functions

NumericVector< Number > & solutionInternal () const override
 Internal getter for solution owned by libMesh. More...
 

Protected Attributes

SystemBase_undisplaced_system
 
libMesh::System_sys
 
SubProblem_subproblem
 The subproblem for whom this class holds variable data, etc; this can either be the governing finite element/volume problem or a subjugate displaced problem. More...
 
FEProblemBase_fe_problem
 the governing finite element/volume problem More...
 
MooseApp_app
 
Factory_factory
 
MooseMesh_mesh
 
std::string _name
 The name of this system. More...
 
std::vector< VariableWarehouse_vars
 Variable warehouses (one for each thread) More...
 
std::map< unsigned int, std::set< SubdomainID > > _var_map
 Map of variables (variable id -> array of subdomains where it lives) More...
 
unsigned int _max_var_number
 Maximum variable number. More...
 
std::vector< std::string > _vars_to_be_zeroed_on_residual
 
std::vector< std::string > _vars_to_be_zeroed_on_jacobian
 
NumericVector< Number > * _u_dot
 solution vector for u^dot More...
 
NumericVector< Number > * _u_dotdot
 solution vector for u^dotdot More...
 
NumericVector< Number > * _u_dot_old
 old solution vector for u^dot More...
 
NumericVector< Number > * _u_dotdot_old
 old solution vector for u^dotdot More...
 
std::vector< Real_du_dot_du
 Derivative of time derivative of u with respect to uj. More...
 
Real _du_dotdot_du
 
std::vector< NumericVector< Number > * > _tagged_vectors
 Tagged vectors (pointer) More...
 
std::vector< libMesh::SparseMatrix< Number > * > _tagged_matrices
 Tagged matrices (pointer) More...
 
std::vector< bool > _matrix_tag_active_flags
 Active flags for tagged matrices. More...
 
NumericVector< Real > * _saved_old
 
NumericVector< Real > * _saved_older
 
NumericVector< Real > * _saved_dot_old
 
NumericVector< Real > * _saved_dotdot_old
 
Moose::VarKindType _var_kind
 default kind of variables in this system More...
 
std::vector< VarCopyInfo_var_to_copy
 
size_t _max_var_n_dofs_per_elem
 Maximum number of dofs for any one variable on any one element. More...
 
size_t _max_var_n_dofs_per_node
 Maximum number of dofs for any one variable on any one node. More...
 
std::vector< std::shared_ptr< TimeIntegrator > > _time_integrators
 Time integrator. More...
 
std::vector< std::vector< MooseVariableFieldBase * > > _numbered_vars
 Map variable number to its pointer. More...
 
bool _automatic_scaling
 Whether to automatically scale the variables. More...
 
bool _verbose
 True if printing out additional information. More...
 
bool _solution_states_initialized
 Whether or not the solution states have been initialized. More...
 
std::vector< dof_id_type_var_all_dof_indices
 Container for the dof indices of a given variable. More...
 
std::unique_ptr< NumericVector< Number > > _serialized_solution
 Serialized version of the solution vector, or nullptr if a serialized solution is not needed. More...
 
std::vector< std::unique_ptr< NumericVector< Number > > > _raw_grad_container
 A cache for storing gradients at dof locations. More...
 
const Parallel::Communicator_communicator
 

Detailed Description

Definition at line 21 of file DisplacedSystem.h.

Constructor & Destructor Documentation

◆ DisplacedSystem() [1/2]

DisplacedSystem::DisplacedSystem ( DisplacedSystem &&  )
delete

◆ DisplacedSystem() [2/2]

DisplacedSystem::DisplacedSystem ( DisplacedProblem problem,
FEProblemBase fe_problem,
SystemBase undisplaced_system,
const std::string &  name,
Moose::VarKindType  var_kind 
)

Definition at line 18 of file DisplacedSystem.C.

23  : SystemBase(problem, fe_problem, name, var_kind),
24  _undisplaced_system(undisplaced_system),
25  _sys(problem.es().add_system<libMesh::System>(name))
26 {
27  if (!problem.defaultGhosting())
28  {
29  auto & dof_map = _sys.get_dof_map();
30  dof_map.remove_algebraic_ghosting_functor(dof_map.default_algebraic_ghosting());
31  dof_map.set_implicit_neighbor_dofs(false);
32  }
33 }
libMesh::System & _sys
virtual EquationSystems & es() override
virtual const std::string & name() const
Definition: SystemBase.C:1330
SystemBase & _undisplaced_system
void remove_algebraic_ghosting_functor(GhostingFunctor &evaluable_functor)
SystemBase(SubProblem &subproblem, FEProblemBase &fe_problem, const std::string &name, Moose::VarKindType var_kind)
Definition: SystemBase.C:56
bool defaultGhosting()
Whether or not the user has requested default ghosting ot be on.
Definition: SubProblem.h:144
const DofMap & get_dof_map() const

◆ ~DisplacedSystem()

DisplacedSystem::~DisplacedSystem ( )
virtual

Definition at line 35 of file DisplacedSystem.C.

35 {}

Member Function Documentation

◆ activeAllMatrixTags()

void SystemBase::activeAllMatrixTags ( )
virtualinherited

Make all exsiting matrices ative.

Definition at line 1137 of file SystemBase.C.

Referenced by NonlinearSystemBase::computeJacobianInternal(), LinearSystem::computeLinearSystemInternal(), NonlinearSystemBase::computeResidualAndJacobianInternal(), and NonlinearSystemBase::computeResidualTags().

1138 {
1139  auto num_matrix_tags = _subproblem.numMatrixTags();
1140 
1141  _matrix_tag_active_flags.resize(num_matrix_tags);
1142 
1143  for (decltype(num_matrix_tags) tag = 0; tag < num_matrix_tags; tag++)
1144  if (hasMatrix(tag))
1145  _matrix_tag_active_flags[tag] = true;
1146  else
1147  _matrix_tag_active_flags[tag] = false;
1148 }
virtual bool hasMatrix(TagID tag) const
Check if the tagged matrix exists in the system.
Definition: SystemBase.h:351
std::vector< bool > _matrix_tag_active_flags
Active flags for tagged matrices.
Definition: SystemBase.h:1019
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual unsigned int numMatrixTags() const
The total number of tags.
Definition: SubProblem.h:248

◆ activeMatrixTag()

void SystemBase::activeMatrixTag ( TagID  tag)
virtualinherited

Active a matrix for tag.

Definition at line 1102 of file SystemBase.C.

1103 {
1104  mooseAssert(_subproblem.matrixTagExists(tag),
1105  "Cannot active Matrix with matrix_tag : " << tag << "that does not exist");
1106 
1107  if (_matrix_tag_active_flags.size() < tag + 1)
1108  _matrix_tag_active_flags.resize(tag + 1);
1109 
1110  _matrix_tag_active_flags[tag] = true;
1111 }
std::vector< bool > _matrix_tag_active_flags
Active flags for tagged matrices.
Definition: SystemBase.h:1019
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual bool matrixTagExists(const TagName &tag_name) const
Check to see if a particular Tag exists.
Definition: SubProblem.C:328

◆ addDotVectors()

virtual void DisplacedSystem::addDotVectors ( )
inlineoverridevirtual

Add u_dot, u_dotdot, u_dot_old and u_dotdot_old vectors if requested by the time integrator.

Reimplemented from SystemBase.

Definition at line 154 of file DisplacedSystem.h.

SystemBase & _undisplaced_system
virtual void addDotVectors()
Add u_dot, u_dotdot, u_dot_old and u_dotdot_old vectors if requested by the time integrator.
Definition: SystemBase.C:1600

◆ addMatrix()

SparseMatrix< Number > & SystemBase::addMatrix ( TagID  tag)
inherited

Adds a matrix with a given tag.

Parameters
tag_nameThe name of the tag

Definition at line 562 of file SystemBase.C.

563 {
564  if (!_subproblem.matrixTagExists(tag))
565  mooseError("Cannot add tagged matrix with TagID ",
566  tag,
567  " in system '",
568  name(),
569  "' because the tag does not exist in the problem");
570 
571  if (hasMatrix(tag))
572  return getMatrix(tag);
573 
574  const auto matrix_name = _subproblem.matrixTagName(tag);
575  SparseMatrix<Number> & mat = system().add_matrix(matrix_name);
576  associateMatrixToTag(mat, tag);
577 
578  return mat;
579 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
virtual bool hasMatrix(TagID tag) const
Check if the tagged matrix exists in the system.
Definition: SystemBase.h:351
virtual void associateMatrixToTag(libMesh::SparseMatrix< Number > &matrix, TagID tag)
Associate a matrix to a tag.
Definition: SystemBase.C:1059
virtual const std::string & name() const
Definition: SystemBase.C:1330
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual libMesh::SparseMatrix< Number > & getMatrix(TagID tag)
Get a raw SparseMatrix.
Definition: SystemBase.C:1007
SparseMatrix< Number > & add_matrix(std::string_view mat_name, ParallelType type=PARALLEL, MatrixBuildType mat_build_type=MatrixBuildType::AUTOMATIC)
virtual bool matrixTagExists(const TagName &tag_name) const
Check to see if a particular Tag exists.
Definition: SubProblem.C:328
virtual TagName matrixTagName(TagID tag)
Retrieve the name associated with a TagID.
Definition: SubProblem.C:357

◆ addScalingVector()

void SystemBase::addScalingVector ( )
inherited

Add the scaling factor vector to the system.

Definition at line 1512 of file SystemBase.C.

Referenced by MooseVariableBase::initialSetup().

1513 {
1514  addVector("scaling_factors", /*project=*/false, libMesh::ParallelType::GHOSTED);
1516 }
NumericVector< Number > & addVector(const std::string &vector_name, const bool project, const libMesh::ParallelType type)
Adds a solution length vector to the system.
void hasScalingVector(const unsigned int nl_sys_num)
Tells this problem that the assembly associated with the given nonlinear system number involves a sca...
Definition: SubProblem.C:1164
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
unsigned int number() const
Gets the number of this system.
Definition: SystemBase.C:1159

◆ addTimeIntegrator()

void SystemBase::addTimeIntegrator ( const std::string &  type,
const std::string &  name,
InputParameters parameters 
)
inherited

Definition at line 1625 of file SystemBase.C.

1628 {
1629  parameters.set<SystemBase *>("_sys") = this;
1630  _time_integrators.push_back(_factory.create<TimeIntegrator>(type, name, parameters));
1631 }
std::vector< std::shared_ptr< TimeIntegrator > > _time_integrators
Time integrator.
Definition: SystemBase.h:1041
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
Factory & _factory
Definition: SystemBase.h:983
Base class for a system (of equations)
Definition: SystemBase.h:84
virtual const std::string & name() const
Definition: SystemBase.C:1330
virtual std::unique_ptr< Base > create()=0
Base class for time integrators.

◆ addVariable()

void SystemBase::addVariable ( const std::string &  var_type,
const std::string &  var_name,
InputParameters parameters 
)
virtualinherited

Canonical method for adding a variable.

Parameters
var_typethe type of the variable, e.g. MooseVariableScalar
var_namethe variable name, e.g. 'u'
paramsthe InputParameters from which to construct the variable

Reimplemented in AuxiliarySystem.

Definition at line 710 of file SystemBase.C.

Referenced by AuxiliarySystem::addVariable().

713 {
715 
716  auto components = parameters.get<unsigned int>("components");
717 
718  // Convert the std::vector parameter provided by the user into a std::set for use by libMesh's
719  // System::add_variable method
720  std::set<SubdomainID> blocks;
721  const auto & block_param = parameters.get<std::vector<SubdomainName>>("block");
722  for (const auto & subdomain_name : block_param)
723  {
724  SubdomainID blk_id = _mesh.getSubdomainID(subdomain_name);
725  blocks.insert(blk_id);
726  }
727 
728  const auto fe_type =
729  FEType(Utility::string_to_enum<Order>(parameters.get<MooseEnum>("order")),
730  Utility::string_to_enum<FEFamily>(parameters.get<MooseEnum>("family")));
731  const auto fe_field_type = FEInterface::field_type(fe_type);
732 
733  unsigned int var_num;
734 
735  if (var_type == "ArrayMooseVariable")
736  {
737  if (fe_field_type == TYPE_VECTOR)
738  mooseError("Vector family type cannot be used in an array variable");
739 
740  std::vector<std::string> array_var_component_names;
741  const bool has_array_names = parameters.isParamValid("array_var_component_names");
742  if (has_array_names)
743  {
744  array_var_component_names =
745  parameters.get<std::vector<std::string>>("array_var_component_names");
746  if (array_var_component_names.size() != components)
747  mooseError("For variable ",
748  name,
749  ", parameter 'array_var_component_names' has ",
750  array_var_component_names.size(),
751  " name(s), but there are ",
752  components,
753  " array variable component(s).");
754  }
755 
756  // Build up the variable names
757  std::vector<std::string> var_names;
758  for (unsigned int i = 0; i < components; i++)
759  {
760  if (!has_array_names)
761  array_var_component_names.push_back(std::to_string(i));
762  var_names.push_back(name + "_" + array_var_component_names[i]);
763  }
764 
765  // makes sure there is always a name, either the provided one or '1 2 3 ...'
766  parameters.set<std::vector<std::string>>("array_var_component_names") =
767  array_var_component_names;
768 
769  // The number returned by libMesh is the _last_ variable number... we want to hold onto the
770  // _first_
771  var_num = system().add_variables(var_names, fe_type, &blocks) - (components - 1);
772 
773  // Set as array variable
774  if (parameters.isParamSetByUser("array") && !parameters.get<bool>("array"))
775  mooseError("Variable '",
776  name,
777  "' is an array variable ('components' > 1) but 'array' is set to false.");
778  parameters.set<bool>("array") = true;
779  }
780  else
781  {
782  if (parameters.isParamSetByUser("array_var_component_names"))
783  mooseError("Variable '",
784  name,
785  "' is a regular variable. 'array_var_component_names' should not be set.");
786  var_num = system().add_variable(name, fe_type, &blocks);
787  }
788 
789  parameters.set<unsigned int>("_var_num") = var_num;
790  parameters.set<SystemBase *>("_system_base") = this;
791 
792  for (THREAD_ID tid = 0; tid < libMesh::n_threads(); tid++)
793  {
794  parameters.set<THREAD_ID>("tid") = tid;
795  std::shared_ptr<MooseVariableBase> var =
796  _factory.create<MooseVariableBase>(var_type, name, parameters, tid);
797 
798  _vars[tid].add(name, var);
799 
800  if (auto fe_var = dynamic_cast<MooseVariableFieldBase *>(var.get()))
801  {
802  auto required_size = var_num + components;
803  if (required_size > _numbered_vars[tid].size())
804  _numbered_vars[tid].resize(required_size);
805  for (MooseIndex(components) component = 0; component < components; ++component)
806  _numbered_vars[tid][var_num + component] = fe_var;
807 
808  if (auto * const functor = dynamic_cast<Moose::FunctorBase<ADReal> *>(fe_var))
809  _subproblem.addFunctor(name, *functor, tid);
810  else if (auto * const functor = dynamic_cast<Moose::FunctorBase<ADRealVectorValue> *>(fe_var))
811  _subproblem.addFunctor(name, *functor, tid);
812  else if (auto * const functor = dynamic_cast<Moose::FunctorBase<RealEigenVector> *>(fe_var))
813  _subproblem.addFunctor(name, *functor, tid);
814  else
815  mooseError("This should be a functor");
816  }
817 
818  if (var->blockRestricted())
819  for (const SubdomainID & id : var->blockIDs())
820  for (MooseIndex(components) component = 0; component < components; ++component)
821  _var_map[var_num + component].insert(id);
822  else
823  for (MooseIndex(components) component = 0; component < components; ++component)
824  _var_map[var_num + component] = std::set<SubdomainID>();
825  }
826 
827  // getMaxVariableNumber is an API method used in Rattlesnake
828  if (var_num > _max_var_number)
829  _max_var_number = var_num;
830  _du_dot_du.resize(var_num + 1);
831 }
unsigned int add_variables(const std::vector< std::string > &vars, const FEType &type, const std::set< subdomain_id_type > *const active_subdomains=nullptr)
std::vector< std::vector< MooseVariableFieldBase * > > _numbered_vars
Map variable number to its pointer.
Definition: SystemBase.h:1044
std::vector< Real > _du_dot_du
Derivative of time derivative of u with respect to uj.
Definition: SystemBase.h:1011
unsigned int n_threads()
char ** blocks
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
Combine two vector parameters into a single vector of pairs.
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
void addFunctor(const std::string &name, const Moose::FunctorBase< T > &functor, const THREAD_ID tid)
add a functor to the problem functor container
Definition: SubProblem.h:1375
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
Factory & _factory
Definition: SystemBase.h:983
Base class for a system (of equations)
Definition: SystemBase.h:84
virtual const std::string & name() const
Definition: SystemBase.C:1330
virtual std::unique_ptr< Base > create()=0
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:33
unsigned int add_variable(std::string_view var, const FEType &type, const std::set< subdomain_id_type > *const active_subdomains=nullptr)
std::map< unsigned int, std::set< SubdomainID > > _var_map
Map of variables (variable id -> array of subdomains where it lives)
Definition: SystemBase.h:992
bool isParamSetByUser(const std::string &name) const
Method returns true if the parameter was set by the user.
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
MooseMesh & _mesh
Definition: SystemBase.h:985
unsigned int _max_var_number
Maximum variable number.
Definition: SystemBase.h:994
unsigned int THREAD_ID
Definition: MooseTypes.h:209
SubdomainID getSubdomainID(const SubdomainName &subdomain_name) const
Get the associated subdomain ID for the subdomain name.
Definition: MooseMesh.C:1728
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.

◆ addVariableToCopy()

void SystemBase::addVariableToCopy ( const std::string &  dest_name,
const std::string &  source_name,
const std::string &  timestep 
)
virtualinherited

Add info about variable that will be copied.

Parameters
dest_nameName of the nodal variable being used for copying into (name is from the exodusII file)
source_nameName of the nodal variable being used for copying from (name is from the exodusII file)
timestepTimestep in the file being used

Definition at line 1177 of file SystemBase.C.

Referenced by CopyNodalVarsAction::act(), and PhysicsBase::copyVariablesFromMesh().

1180 {
1181  _var_to_copy.push_back(VarCopyInfo(dest_name, source_name, timestep));
1182 }
std::vector< VarCopyInfo > _var_to_copy
Definition: SystemBase.h:1032
Information about variables that will be copied.
Definition: SystemBase.h:66

◆ addVariableToZeroOnJacobian()

virtual void DisplacedSystem::addVariableToZeroOnJacobian ( std::string  var_name)
inlineoverridevirtual

Adds this variable to the list of variables to be zeroed during each jacobian evaluation.

Parameters
var_nameThe name of the variable to be zeroed.

Reimplemented from SystemBase.

Definition at line 197 of file DisplacedSystem.h.

198  {
200  }
SystemBase & _undisplaced_system
virtual void addVariableToZeroOnJacobian(std::string var_name)
Adds this variable to the list of variables to be zeroed during each Jacobian evaluation.
Definition: SystemBase.C:179

◆ addVariableToZeroOnResidual()

virtual void DisplacedSystem::addVariableToZeroOnResidual ( std::string  var_name)
inlineoverridevirtual

Adds this variable to the list of variables to be zeroed during each residual evaluation.

Parameters
var_nameThe name of the variable to be zeroed.

Reimplemented from SystemBase.

Definition at line 188 of file DisplacedSystem.h.

189  {
191  }
SystemBase & _undisplaced_system
virtual void addVariableToZeroOnResidual(std::string var_name)
Adds this variable to the list of variables to be zeroed during each residual evaluation.
Definition: SystemBase.C:173

◆ addVector() [1/2]

NumericVector<Number>& SystemBase::addVector ( const std::string &  vector_name,
const bool  project,
const libMesh::ParallelType  type 
)
inherited

Adds a solution length vector to the system.

Parameters
vector_nameThe name of the vector.
projectWhether or not to project this vector when doing mesh refinement. If the vector is just going to be recomputed then there is no need to project it.
typeWhat type of parallel vector. This is usually either PARALLEL or GHOSTED. GHOSTED is needed if you are going to be accessing off-processor entries. The ghosting pattern is the same as the solution vector.

Referenced by SystemBase::addDotVectors(), SystemBase::addScalingVector(), NonlinearTimeIntegratorInterface::addVector(), SecantSolve::allocateStorage(), SteffensenSolve::allocateStorage(), PicardSolve::allocateStorage(), NonlinearSystemBase::getResidualNonTimeVector(), NonlinearSystemBase::getResidualTimeVector(), CentralDifference::initialSetup(), SystemBase::needSolutionState(), NonlinearSystemBase::residualGhosted(), and SystemBase::saveOldSolutions().

◆ addVector() [2/2]

NumericVector<Number>& SystemBase::addVector ( TagID  tag,
const bool  project,
const libMesh::ParallelType  type 
)
inherited

Adds a solution length vector to the system with the specified TagID.

Parameters
tag_nameThe name of the tag
projectWhether or not to project this vector when doing mesh refinement. If the vector is just going to be recomputed then there is no need to project it.
typeWhat type of parallel vector. This is usually either PARALLEL or GHOSTED. GHOSTED is needed if you are going to be accessing off-processor entries. The ghosting pattern is the same as the solution vector.

◆ applyScalingFactors()

void SystemBase::applyScalingFactors ( const std::vector< Real > &  inverse_scaling_factors)
inherited

Applies scaling factors to the system's variables.

Parameters
inverse_scaling_factorsA vector containing the inverse of each variable's scaling factor, e.g. 1 / scaling_factor

Definition at line 1462 of file SystemBase.C.

Referenced by NonlinearSystemBase::computeScaling().

1463 {
1464  for (MooseIndex(_vars) thread = 0; thread < _vars.size(); ++thread)
1465  {
1466  auto & field_variables = _vars[thread].fieldVariables();
1467  for (MooseIndex(field_variables) i = 0, p = 0; i < field_variables.size(); ++i)
1468  {
1469  auto factors = field_variables[i]->arrayScalingFactor();
1470  for (unsigned int j = 0; j < field_variables[i]->count(); ++j, ++p)
1471  factors[j] /= inverse_scaling_factors[p];
1472 
1473  field_variables[i]->scalingFactor(factors);
1474  }
1475 
1476  auto offset = field_variables.size();
1477 
1478  auto & scalar_variables = _vars[thread].scalars();
1479  for (MooseIndex(scalar_variables) i = 0; i < scalar_variables.size(); ++i)
1480  scalar_variables[i]->scalingFactor(
1481  {1. / inverse_scaling_factors[offset + i] * scalar_variables[i]->scalingFactor()});
1482 
1483  if (thread == 0 && _verbose)
1484  {
1485  _console << "Automatic scaling factors:\n";
1486  auto original_flags = _console.flags();
1487  auto original_precision = _console.precision();
1488  _console.unsetf(std::ios_base::floatfield);
1489  _console.precision(6);
1490 
1491  for (const auto & field_variable : field_variables)
1492  {
1493  const auto & factors = field_variable->arrayScalingFactor();
1494  _console << " " << field_variable->name() << ":";
1495  for (const auto i : make_range(field_variable->count()))
1496  _console << " " << factors[i];
1497  _console << "\n";
1498  }
1499  for (const auto & scalar_variable : scalar_variables)
1500  _console << " " << scalar_variable->name() << ": " << scalar_variable->scalingFactor()
1501  << "\n";
1502  _console << "\n" << std::endl;
1503 
1504  // restore state
1505  _console.flags(original_flags);
1506  _console.precision(original_precision);
1507  }
1508  }
1509 }
std::ios_base::fmtflags flags() const
Return the current flags.
Definition: ConsoleStream.C:56
void unsetf(std::ios_base::fmtflags mask) const
Unset format flags.
Definition: ConsoleStream.C:38
std::streamsize precision() const
Return the current precision.
Definition: ConsoleStream.C:44
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
bool _verbose
True if printing out additional information.
Definition: SystemBase.h:1050
IntRange< T > make_range(T beg, T end)
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.

◆ assignMaxVarNDofsPerElem()

void SystemBase::assignMaxVarNDofsPerElem ( std::size_t  max_dofs)
inlineinherited

assign the maximum element dofs

Definition at line 598 of file SystemBase.h.

598 { _max_var_n_dofs_per_elem = max_dofs; }
size_t _max_var_n_dofs_per_elem
Maximum number of dofs for any one variable on any one element.
Definition: SystemBase.h:1035

◆ assignMaxVarNDofsPerNode()

void SystemBase::assignMaxVarNDofsPerNode ( std::size_t  max_dofs)
inlineinherited

assign the maximum node dofs

Definition at line 603 of file SystemBase.h.

603 { _max_var_n_dofs_per_node = max_dofs; }
size_t _max_var_n_dofs_per_node
Maximum number of dofs for any one variable on any one node.
Definition: SystemBase.h:1038

◆ associateMatrixToTag()

virtual void DisplacedSystem::associateMatrixToTag ( libMesh::SparseMatrix< Number > &  matrix,
TagID  tag 
)
inlineoverridevirtual

Associate a matrix to a tag.

Reimplemented from SystemBase.

Definition at line 83 of file DisplacedSystem.h.

84  {
86  }
virtual void associateMatrixToTag(libMesh::SparseMatrix< Number > &matrix, TagID tag)
Associate a matrix to a tag.
Definition: SystemBase.C:1059
SystemBase & _undisplaced_system

◆ associateVectorToTag()

virtual void DisplacedSystem::associateVectorToTag ( NumericVector< Number > &  vec,
TagID  tag 
)
inlineoverridevirtual

Associate a vector for a given tag.

Reimplemented from SystemBase.

Definition at line 63 of file DisplacedSystem.h.

64  {
66  }
virtual void associateVectorToTag(NumericVector< Number > &vec, TagID tag)
Associate a vector for a given tag.
Definition: SystemBase.C:964
SystemBase & _undisplaced_system

◆ augmentSendList()

virtual void DisplacedSystem::augmentSendList ( std::vector< dof_id_type > &  send_list)
inlineoverridevirtual

Will modify the send_list to add all of the extra ghosted dofs for this system.

Reimplemented from SystemBase.

Definition at line 169 of file DisplacedSystem.h.

170  {
172  }
SystemBase & _undisplaced_system
virtual void augmentSendList(std::vector< dof_id_type > &send_list)
Will modify the send_list to add all of the extra ghosted dofs for this system.
Definition: SystemBase.C:444

◆ augmentSparsity()

virtual void DisplacedSystem::augmentSparsity ( libMesh::SparsityPattern::Graph ,
std::vector< dof_id_type > &  ,
std::vector< dof_id_type > &   
)
inlineoverridevirtual

This is an empty function since the displaced system doesn't have a matrix! All sparsity pattern modification will be taken care of by the undisplaced system directly.

Implements SystemBase.

Definition at line 178 of file DisplacedSystem.h.

181  {
182  }

◆ automaticScaling() [1/2]

bool SystemBase::automaticScaling ( ) const
inlineinherited

Getter for whether we are performing automatic scaling.

Returns
whether we are performing automatic scaling

Definition at line 122 of file SystemBase.h.

Referenced by SubProblem::automaticScaling().

122 { return _automatic_scaling; }
bool _automatic_scaling
Whether to automatically scale the variables.
Definition: SystemBase.h:1047

◆ automaticScaling() [2/2]

void SystemBase::automaticScaling ( bool  automatic_scaling)
inlineinherited

Setter for whether we are performing automatic scaling.

Parameters
automatic_scalingA boolean representing whether we are performing automatic scaling

Definition at line 128 of file SystemBase.h.

128 { _automatic_scaling = automatic_scaling; }
bool _automatic_scaling
Whether to automatically scale the variables.
Definition: SystemBase.h:1047

◆ clearAllDofIndices()

void SystemBase::clearAllDofIndices ( )
inherited

Clear all dof indices from moose variables.

Definition at line 1580 of file SystemBase.C.

Referenced by SubProblem::clearAllDofIndices().

1581 {
1582  for (auto & var_warehouse : _vars)
1583  var_warehouse.clearAllDofIndices();
1584 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ closeTaggedMatrices()

void SystemBase::closeTaggedMatrices ( const std::set< TagID > &  tags)
inherited

Close all matrices associated the tags.

Definition at line 1043 of file SystemBase.C.

Referenced by NonlinearSystemBase::computeJacobianInternal(), LinearSystem::computeLinearSystemInternal(), and NonlinearSystemBase::computeResidualAndJacobianTags().

1044 {
1045  for (auto tag : tags)
1046  if (hasMatrix(tag))
1047  getMatrix(tag).close();
1048 }
virtual bool hasMatrix(TagID tag) const
Check if the tagged matrix exists in the system.
Definition: SystemBase.h:351
virtual void close()=0
virtual libMesh::SparseMatrix< Number > & getMatrix(TagID tag)
Get a raw SparseMatrix.
Definition: SystemBase.C:1007

◆ closeTaggedVector()

void SystemBase::closeTaggedVector ( const TagID  tag)
inherited

Close vector with the given tag.

Definition at line 641 of file SystemBase.C.

Referenced by SystemBase::closeTaggedVectors().

642 {
643  if (!_subproblem.vectorTagExists(tag))
644  mooseError("Cannot close vector with TagID ",
645  tag,
646  " in system '",
647  name(),
648  "' because that tag does not exist in the problem");
649  else if (!hasVector(tag))
650  mooseError("Cannot close vector tag with name '",
652  "' in system '",
653  name(),
654  "' because there is no vector associated with that tag");
655  getVector(tag).close();
656 }
bool hasVector(const std::string &tag_name) const
Check if the named vector exists in the system.
Definition: SystemBase.C:907
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
virtual const std::string & name() const
Definition: SystemBase.C:1330
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual bool vectorTagExists(const TagID tag_id) const
Check to see if a particular Tag exists.
Definition: SubProblem.h:201
virtual void close()=0
virtual TagName vectorTagName(const TagID tag) const
Retrieve the name associated with a TagID.
Definition: SubProblem.C:221
virtual NumericVector< Number > & getVector(const std::string &name)
Get a raw NumericVector by name.
Definition: SystemBase.C:916

◆ closeTaggedVectors()

void SystemBase::closeTaggedVectors ( const std::set< TagID > &  tags)
inherited

Close all vectors for given tags.

Definition at line 659 of file SystemBase.C.

Referenced by NonlinearSystemBase::computeResidualAndJacobianTags(), NonlinearSystemBase::computeResidualTags(), NonlinearSystem::stopSolve(), and LinearSystem::stopSolve().

660 {
661  for (const auto tag : tags)
662  closeTaggedVector(tag);
663 }
void closeTaggedVector(const TagID tag)
Close vector with the given tag.
Definition: SystemBase.C:641

◆ compute()

virtual void DisplacedSystem::compute ( ExecFlagType  type)
inlineoverridevirtual

Compute time derivatives, auxiliary variables, etc.

Parameters
typeOur current execution stage

Implements SystemBase.

Definition at line 249 of file DisplacedSystem.h.

249 {}

◆ computeVariables()

virtual void SystemBase::computeVariables ( const NumericVector< Number > &  )
inlinevirtualinherited

Definition at line 870 of file SystemBase.h.

870 {}

◆ computingScalingJacobian()

bool SystemBase::computingScalingJacobian ( ) const
inherited

Whether we are computing an initial Jacobian for automatic variable scaling.

Definition at line 1519 of file SystemBase.C.

Referenced by Assembly::addJacobianBlock(), Assembly::addJacobianBlockNonlocal(), Kernel::computeJacobian(), VectorKernel::computeJacobian(), EigenKernel::computeJacobian(), and FEProblemBase::computeJacobianTags().

1520 {
1522 }
virtual bool computingScalingJacobian() const =0
Getter for whether we&#39;re computing the scaling jacobian.
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977

◆ copyOldSolutions()

void SystemBase::copyOldSolutions ( )
virtualinherited

Shifts the solutions backwards in time.

Definition at line 1288 of file SystemBase.C.

Referenced by SystemBase::copySolutionsBackwards(), and EigenExecutionerBase::inversePowerIteration().

1289 {
1290  // Copying the solutions backward so the current solution will become the old, and the old will
1291  // become older. 0 index is for time, 1 would be nonlinear iteration.
1292  const auto states = _solution_states[0].size();
1293  if (states > 1)
1294  for (unsigned int i = states - 1; i > 0; --i)
1295  solutionState(i) = solutionState(i - 1);
1296 
1297  if (solutionUDotOld())
1298  *solutionUDotOld() = *solutionUDot();
1299  if (solutionUDotDotOld())
1301 }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419
virtual NumericVector< Number > * solutionUDotDotOld()
Definition: SystemBase.h:255
virtual NumericVector< Number > * solutionUDot()
Definition: SystemBase.h:252
virtual NumericVector< Number > * solutionUDotOld()
Definition: SystemBase.h:254
std::array< std::vector< NumericVector< Number > * >, 2 > _solution_states
The solution states (0 = current, 1 = old, 2 = older, etc)
Definition: SystemBase.h:1075
virtual NumericVector< Number > * solutionUDotDot()
Definition: SystemBase.h:253

◆ copyPreviousNonlinearSolutions()

void SystemBase::copyPreviousNonlinearSolutions ( )
virtualinherited

Shifts the solutions backwards in nonlinear iteration history.

Definition at line 1271 of file SystemBase.C.

Referenced by SystemBase::copySolutionsBackwards().

1272 {
1273  // 1 is for nonlinear, 0 is for time, we do this for nonlinear only here
1274  const auto states = _solution_states[1].size();
1275  if (states > 1)
1276  for (unsigned int i = states - 1; i > 0; --i)
1279 
1280  if (solutionPreviousNewton())
1282 }
virtual const NumericVector< Number > *const & currentSolution() const =0
The solution vector that is currently being operated on.
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419
std::array< std::vector< NumericVector< Number > * >, 2 > _solution_states
The solution states (0 = current, 1 = old, 2 = older, etc)
Definition: SystemBase.h:1075
virtual const NumericVector< Number > * solutionPreviousNewton() const
Definition: SystemBase.C:1345

◆ copySolutionsBackwards()

void SystemBase::copySolutionsBackwards ( )
virtualinherited

Copy current solution into old and older.

Definition at line 1260 of file SystemBase.C.

1261 {
1262  system().update();
1263  copyOldSolutions();
1265 }
virtual void copyOldSolutions()
Shifts the solutions backwards in time.
Definition: SystemBase.C:1288
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
virtual void copyPreviousNonlinearSolutions()
Shifts the solutions backwards in nonlinear iteration history.
Definition: SystemBase.C:1271
virtual void update()

◆ copyTimeIntegrators()

void SystemBase::copyTimeIntegrators ( const SystemBase other_sys)
inherited

Copy time integrators from another system.

Definition at line 1634 of file SystemBase.C.

1635 {
1637 }
std::vector< std::shared_ptr< TimeIntegrator > > _time_integrators
Time integrator.
Definition: SystemBase.h:1041

◆ copyVars()

void SystemBase::copyVars ( libMesh::ExodusII_IO io)
inherited

Definition at line 1185 of file SystemBase.C.

1186 {
1187  int n_steps = io.get_num_time_steps();
1188 
1189  bool did_copy = false;
1190  for (const auto & vci : _var_to_copy)
1191  {
1192  int timestep = -1;
1193 
1194  if (vci._timestep == "LATEST")
1195  // Use the last time step in the file from which to retrieve the solution
1196  timestep = n_steps;
1197  else
1198  {
1199  timestep = MooseUtils::convert<int>(vci._timestep);
1200  if (timestep > n_steps)
1201  mooseError("Invalid value passed as \"initial_from_file_timestep\". Expected \"LATEST\" or "
1202  "a valid integer between 1 and ",
1203  n_steps,
1204  " inclusive, received ",
1205  vci._timestep);
1206  }
1207 
1208  did_copy = true;
1209 
1210  if (hasVariable(vci._dest_name))
1211  {
1212  const auto & var = getVariable(0, vci._dest_name);
1213  if (var.isArray())
1214  {
1215  const auto & array_var = getFieldVariable<RealEigenVector>(0, vci._dest_name);
1216  for (MooseIndex(var.count()) i = 0; i < var.count(); ++i)
1217  {
1218  const auto & exodus_var = var.arrayVariableComponent(i);
1219  const auto & system_var = array_var.componentName(i);
1220  if (var.isNodal())
1221  io.copy_nodal_solution(system(), exodus_var, system_var, timestep);
1222  else
1223  io.copy_elemental_solution(system(), exodus_var, system_var, timestep);
1224  }
1225  }
1226  else
1227  {
1228  if (var.isNodal())
1229  io.copy_nodal_solution(system(), vci._dest_name, vci._source_name, timestep);
1230  else
1231  io.copy_elemental_solution(system(), vci._dest_name, vci._source_name, timestep);
1232  }
1233  }
1234  else if (hasScalarVariable(vci._dest_name))
1235  io.copy_scalar_solution(system(), {vci._dest_name}, {vci._source_name}, timestep);
1236  else
1237  mooseError("Unrecognized variable ", vci._dest_name, " in variables to copy.");
1238  }
1239 
1240  if (did_copy)
1241  solution().close();
1242 }
NumericVector< Number > & solution()
Definition: SystemBase.h:195
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
std::vector< VarCopyInfo > _var_to_copy
Definition: SystemBase.h:1032
int convert< int >(const std::string &str, bool throw_on_failure)
Definition: MooseUtils.C:1009
void copy_nodal_solution(System &system, std::string system_var_name, std::string exodus_var_name, unsigned int timestep=1)
void copy_elemental_solution(System &system, std::string system_var_name, std::string exodus_var_name, unsigned int timestep=1)
virtual bool hasVariable(const std::string &var_name) const
Query a system for a variable.
Definition: SystemBase.C:834
virtual void close()=0
void copy_scalar_solution(System &system, std::vector< std::string > system_var_names, std::vector< std::string > exodus_var_names, unsigned int timestep=1)
MooseVariableFieldBase & getVariable(THREAD_ID tid, const std::string &var_name) const
Gets a reference to a variable of with specified name.
Definition: SystemBase.C:89
virtual bool hasScalarVariable(const std::string &var_name) const
Definition: SystemBase.C:859

◆ currentSolution()

const NumericVector<Number>* const& DisplacedSystem::currentSolution ( ) const
inlineoverridevirtual

The solution vector that is currently being operated on.

This is typically a ghosted vector that comes in from the Nonlinear solver.

Implements SystemBase.

Definition at line 111 of file DisplacedSystem.h.

112  {
114  }
virtual const NumericVector< Number > *const & currentSolution() const =0
The solution vector that is currently being operated on.
SystemBase & _undisplaced_system

◆ customSetup()

void SystemBase::customSetup ( const ExecFlagType exec_type)
virtualinherited

Reimplemented in NonlinearSystemBase, and AuxiliarySystem.

Definition at line 1552 of file SystemBase.C.

Referenced by AuxiliarySystem::customSetup(), and NonlinearSystemBase::customSetup().

1553 {
1554  for (THREAD_ID tid = 0; tid < libMesh::n_threads(); tid++)
1555  _vars[tid].customSetup(exec_type);
1556 }
unsigned int n_threads()
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
virtual void customSetup(const ExecFlagType &exec_type)
Definition: SystemBase.C:1552
unsigned int THREAD_ID
Definition: MooseTypes.h:209

◆ deactiveAllMatrixTags()

void SystemBase::deactiveAllMatrixTags ( )
virtualinherited

Make matrices inactive.

Definition at line 1126 of file SystemBase.C.

Referenced by NonlinearSystemBase::computeResidualTags(), and NonlinearSystemBase::setInitialSolution().

1127 {
1128  auto num_matrix_tags = _subproblem.numMatrixTags();
1129 
1130  _matrix_tag_active_flags.resize(num_matrix_tags);
1131 
1132  for (decltype(num_matrix_tags) tag = 0; tag < num_matrix_tags; tag++)
1133  _matrix_tag_active_flags[tag] = false;
1134 }
std::vector< bool > _matrix_tag_active_flags
Active flags for tagged matrices.
Definition: SystemBase.h:1019
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual unsigned int numMatrixTags() const
The total number of tags.
Definition: SubProblem.h:248

◆ deactiveMatrixTag()

void SystemBase::deactiveMatrixTag ( TagID  tag)
virtualinherited

deactive a matrix for tag

Definition at line 1114 of file SystemBase.C.

1115 {
1116  mooseAssert(_subproblem.matrixTagExists(tag),
1117  "Cannot deactivate Matrix with matrix_tag : " << tag << "that does not exist");
1118 
1119  if (_matrix_tag_active_flags.size() < tag + 1)
1120  _matrix_tag_active_flags.resize(tag + 1);
1121 
1122  _matrix_tag_active_flags[tag] = false;
1123 }
std::vector< bool > _matrix_tag_active_flags
Active flags for tagged matrices.
Definition: SystemBase.h:1019
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual bool matrixTagExists(const TagName &tag_name) const
Check to see if a particular Tag exists.
Definition: SubProblem.C:328

◆ defaultMatrixTags()

virtual std::set<TagID> DisplacedSystem::defaultMatrixTags ( ) const
inlineoverridevirtual

Get the default matrix tags associted with this system.

Reimplemented from SystemBase.

Definition at line 58 of file DisplacedSystem.h.

59  {
61  }
SystemBase & _undisplaced_system
virtual std::set< TagID > defaultMatrixTags() const
Get the default matrix tags associted with this system.
Definition: SystemBase.h:310

◆ defaultVectorTags()

virtual std::set<TagID> DisplacedSystem::defaultVectorTags ( ) const
inlineoverridevirtual

Get the default vector tags associated with this system.

Reimplemented from SystemBase.

Definition at line 54 of file DisplacedSystem.h.

55  {
57  }
SystemBase & _undisplaced_system
virtual std::set< TagID > defaultVectorTags() const
Get the default vector tags associated with this system.
Definition: SystemBase.h:303

◆ disassociateDefaultMatrixTags()

virtual void DisplacedSystem::disassociateDefaultMatrixTags ( )
inlineoverridevirtual

Disassociate the matrices associated with the default matrix tags of this system.

Reimplemented from SystemBase.

Definition at line 98 of file DisplacedSystem.h.

99  {
101  }
SystemBase & _undisplaced_system
virtual void disassociateDefaultMatrixTags()
Disassociate the matrices associated with the default matrix tags of this system. ...
Definition: SystemBase.C:1093

◆ disassociateDefaultVectorTags()

virtual void DisplacedSystem::disassociateDefaultVectorTags ( )
inlineoverridevirtual

Disassociate the vectors associated with the default vector tags of this system.

Reimplemented from SystemBase.

Definition at line 78 of file DisplacedSystem.h.

79  {
81  }
virtual void disassociateDefaultVectorTags()
Disassociate the vectors associated with the default vector tags of this system.
Definition: SystemBase.C:998
SystemBase & _undisplaced_system

◆ disassociateMatrixFromTag() [1/2]

virtual void DisplacedSystem::disassociateMatrixFromTag ( libMesh::SparseMatrix< Number > &  matrix,
TagID  tag 
)
inlineoverridevirtual

Disassociate a matrix from a tag.

Reimplemented from SystemBase.

Definition at line 88 of file DisplacedSystem.h.

89  {
91  }
virtual void disassociateMatrixFromTag(libMesh::SparseMatrix< Number > &matrix, TagID tag)
Disassociate a matrix from a tag.
Definition: SystemBase.C:1071
SystemBase & _undisplaced_system

◆ disassociateMatrixFromTag() [2/2]

virtual void DisplacedSystem::disassociateMatrixFromTag ( TagID  tag)
inlineoverridevirtual

Disassociate any matrix that is associated with a given tag.

Reimplemented from SystemBase.

Definition at line 93 of file DisplacedSystem.h.

94  {
96  }
virtual void disassociateMatrixFromTag(libMesh::SparseMatrix< Number > &matrix, TagID tag)
Disassociate a matrix from a tag.
Definition: SystemBase.C:1071
SystemBase & _undisplaced_system

◆ disassociateVectorFromTag() [1/2]

virtual void DisplacedSystem::disassociateVectorFromTag ( NumericVector< Number > &  vec,
TagID  tag 
)
inlineoverridevirtual

Disassociate a given vector from a given tag.

Reimplemented from SystemBase.

Definition at line 68 of file DisplacedSystem.h.

69  {
71  }
SystemBase & _undisplaced_system
virtual void disassociateVectorFromTag(NumericVector< Number > &vec, TagID tag)
Disassociate a given vector from a given tag.

◆ disassociateVectorFromTag() [2/2]

virtual void DisplacedSystem::disassociateVectorFromTag ( TagID  tag)
inlineoverridevirtual

Disassociate any vector that is associated with a given tag.

Reimplemented from SystemBase.

Definition at line 73 of file DisplacedSystem.h.

74  {
76  }
SystemBase & _undisplaced_system
virtual void disassociateVectorFromTag(NumericVector< Number > &vec, TagID tag)
Disassociate a given vector from a given tag.

◆ dofMap() [1/2]

DofMap & SystemBase::dofMap ( )
virtualinherited

◆ dofMap() [2/2]

const DofMap & SystemBase::dofMap ( ) const
virtualinherited

Gets const reference to the dof map.

Definition at line 1171 of file SystemBase.C.

1172 {
1173  return system().get_dof_map();
1174 }
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
const DofMap & get_dof_map() const

◆ duDotDotDu() [1/2]

virtual Number& DisplacedSystem::duDotDotDu ( )
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 150 of file DisplacedSystem.h.

150 { return _undisplaced_system.duDotDotDu(); }
virtual Number & duDotDotDu()
Definition: SystemBase.h:248
SystemBase & _undisplaced_system

◆ duDotDotDu() [2/2]

virtual const Number& DisplacedSystem::duDotDotDu ( ) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 152 of file DisplacedSystem.h.

152 { return _undisplaced_system.duDotDotDu(); }
virtual Number & duDotDotDu()
Definition: SystemBase.h:248
SystemBase & _undisplaced_system

◆ duDotDu()

const Number & DisplacedSystem::duDotDu ( unsigned int  var_num = 0) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 296 of file DisplacedSystem.h.

297 {
298  return _undisplaced_system.duDotDu(var_num);
299 }
virtual const Number & duDotDu(unsigned int var_num=0) const
Definition: SystemBase.C:1668
SystemBase & _undisplaced_system

◆ duDotDus()

virtual std::vector<Number>& DisplacedSystem::duDotDus ( )
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 149 of file DisplacedSystem.h.

149 { return _undisplaced_system.duDotDus(); }
SystemBase & _undisplaced_system
virtual std::vector< Number > & duDotDus()
Definition: SystemBase.h:247

◆ feProblem() [1/2]

FEProblemBase& SystemBase::feProblem ( )
inlineinherited

Definition at line 103 of file SystemBase.h.

Referenced by DMMooseGetEmbedding_Private(), and DMSetUp_Moose_Pre().

103 { return _fe_problem; }
FEProblemBase & _fe_problem
the governing finite element/volume problem
Definition: SystemBase.h:980

◆ feProblem() [2/2]

const FEProblemBase& SystemBase::feProblem ( ) const
inlineinherited

Definition at line 104 of file SystemBase.h.

104 { return _fe_problem; }
FEProblemBase & _fe_problem
the governing finite element/volume problem
Definition: SystemBase.h:980

◆ flushTaggedMatrices()

void SystemBase::flushTaggedMatrices ( const std::set< TagID > &  tags)
inherited

flushes all matrices associated to tags.

Flush assembles the matrix but doesn't shrink memory allocation

Definition at line 1051 of file SystemBase.C.

1052 {
1053  for (auto tag : tags)
1054  if (hasMatrix(tag))
1055  getMatrix(tag).flush();
1056 }
virtual bool hasMatrix(TagID tag) const
Check if the tagged matrix exists in the system.
Definition: SystemBase.h:351
virtual void flush()
virtual libMesh::SparseMatrix< Number > & getMatrix(TagID tag)
Get a raw SparseMatrix.
Definition: SystemBase.C:1007

◆ getActualFieldVariable() [1/2]

template<typename T >
MooseVariableField< T > & SystemBase::getActualFieldVariable ( THREAD_ID  tid,
const std::string &  var_name 
)
inherited

Returns a field variable pointer - this includes finite volume variables.

Definition at line 117 of file SystemBase.C.

Referenced by BoundsBase::BoundsBase(), Assembly::copyFaceShapes(), Assembly::copyNeighborShapes(), and Assembly::copyShapes().

118 {
119  return *_vars[tid].getActualFieldVariable<T>(var_name);
120 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ getActualFieldVariable() [2/2]

template<typename T >
MooseVariableField< T > & SystemBase::getActualFieldVariable ( THREAD_ID  tid,
unsigned int  var_number 
)
inherited

Returns a field variable pointer - this includes finite volume variables.

Definition at line 138 of file SystemBase.C.

139 {
140  return *_vars[tid].getActualFieldVariable<T>(var_number);
141 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ getFieldVariable() [1/2]

template<typename T >
MooseVariableFE< T > & SystemBase::getFieldVariable ( THREAD_ID  tid,
const std::string &  var_name 
)
inherited

Gets a reference to a variable of with specified name.

This excludes and cannot return finite volume variables.

Parameters
tidThread id
var_namevariable name
Returns
reference the variable (class)

Definition at line 110 of file SystemBase.C.

Referenced by Marker::getMarkerValue().

111 {
112  return *_vars[tid].getFieldVariable<T>(var_name);
113 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ getFieldVariable() [2/2]

template<typename T >
MooseVariableFE< T > & SystemBase::getFieldVariable ( THREAD_ID  tid,
unsigned int  var_number 
)
inherited

Gets a reference to a variable with specified number.

This excludes and cannot return finite volume variables.

Parameters
tidThread id
var_numberlibMesh variable number
Returns
reference the variable (class)

Definition at line 131 of file SystemBase.C.

132 {
133  return *_vars[tid].getFieldVariable<T>(var_number);
134 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ getFVVariable()

template<typename T >
template MooseVariableFV< Real > & SystemBase::getFVVariable< Real > ( THREAD_ID  tid,
const std::string &  var_name 
)
inherited

Return a finite volume variable.

Definition at line 124 of file SystemBase.C.

125 {
126  return *_vars[tid].getFVVariable<T>(var_name);
127 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ getMatrix() [1/2]

virtual libMesh::SparseMatrix<Number>& DisplacedSystem::getMatrix ( TagID  tag)
inlineoverridevirtual

Get a raw SparseMatrix.

Reimplemented from SystemBase.

Definition at line 235 of file DisplacedSystem.h.

236  {
237  return _undisplaced_system.getMatrix(tag);
238  }
SystemBase & _undisplaced_system
virtual libMesh::SparseMatrix< Number > & getMatrix(TagID tag)
Get a raw SparseMatrix.
Definition: SystemBase.C:1007

◆ getMatrix() [2/2]

virtual const libMesh::SparseMatrix<Number>& DisplacedSystem::getMatrix ( TagID  tag) const
inlineoverridevirtual

Get a raw SparseMatrix.

Reimplemented from SystemBase.

Definition at line 239 of file DisplacedSystem.h.

240  {
241  return _undisplaced_system.getMatrix(tag);
242  }
SystemBase & _undisplaced_system
virtual libMesh::SparseMatrix< Number > & getMatrix(TagID tag)
Get a raw SparseMatrix.
Definition: SystemBase.C:1007

◆ getMaxVariableNumber()

unsigned int SystemBase::getMaxVariableNumber ( ) const
inlineinherited

Returns the maximum number of all variables on the system.

Definition at line 868 of file SystemBase.h.

868 { return _max_var_number; }
unsigned int _max_var_number
Maximum variable number.
Definition: SystemBase.h:994

◆ getMaxVarNDofsPerElem()

std::size_t SystemBase::getMaxVarNDofsPerElem ( ) const
inlineinherited

Gets the maximum number of dofs used by any one variable on any one element.

Returns
The max

Definition at line 586 of file SystemBase.h.

Referenced by Moose::globalDofIndexToDerivative().

586 { return _max_var_n_dofs_per_elem; }
size_t _max_var_n_dofs_per_elem
Maximum number of dofs for any one variable on any one element.
Definition: SystemBase.h:1035

◆ getMaxVarNDofsPerNode()

std::size_t SystemBase::getMaxVarNDofsPerNode ( ) const
inlineinherited

Gets the maximum number of dofs used by any one variable on any one node.

Returns
The max

Definition at line 593 of file SystemBase.h.

593 { return _max_var_n_dofs_per_node; }
size_t _max_var_n_dofs_per_node
Maximum number of dofs for any one variable on any one node.
Definition: SystemBase.h:1038

◆ getMinQuadratureOrder()

Order SystemBase::getMinQuadratureOrder ( )
virtualinherited

Get minimal quadrature order needed for integrating variables in this system.

Returns
The minimal order of quadrature

Reimplemented in AuxiliarySystem.

Definition at line 240 of file SystemBase.C.

241 {
242  Order order = CONSTANT;
243  const std::vector<MooseVariableFieldBase *> & vars = _vars[0].fieldVariables();
244  for (const auto & var : vars)
245  {
246  FEType fe_type = var->feType();
247  if (fe_type.default_quadrature_order() > order)
248  order = fe_type.default_quadrature_order();
249  }
250 
251  return order;
252 }
Order
char ** vars
Order default_quadrature_order() const
CONSTANT
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ getScalarVariable() [1/2]

MooseVariableScalar & SystemBase::getScalarVariable ( THREAD_ID  tid,
const std::string &  var_name 
) const
virtualinherited

Gets a reference to a scalar variable with specified number.

Parameters
tidThread id
var_nameA string which is the name of the variable to get.
Returns
reference the variable (class)

Definition at line 144 of file SystemBase.C.

Referenced by Assembly::addJacobianOffDiagScalar(), ODEKernel::computeOffDiagJacobianScalar(), VectorKernel::computeOffDiagJacobianScalar(), ArrayKernel::computeOffDiagJacobianScalar(), IntegratedBC::computeOffDiagJacobianScalar(), VectorIntegratedBC::computeOffDiagJacobianScalar(), ArrayIntegratedBC::computeOffDiagJacobianScalar(), Kernel::computeOffDiagJacobianScalar(), ScalarLagrangeMultiplier::computeOffDiagJacobianScalar(), MortarScalarBase::computeOffDiagJacobianScalar(), KernelScalarBase::computeOffDiagJacobianScalarLocal(), KernelScalarBase::computeScalarOffDiagJacobianScalar(), MortarScalarBase::computeScalarOffDiagJacobianScalar(), DMMooseSetVariables(), Assembly::init(), ReferenceResidualConvergence::initialSetup(), and NonlinearSystemBase::setupScalingData().

145 {
146  MooseVariableScalar * var = dynamic_cast<MooseVariableScalar *>(_vars[tid].getVariable(var_name));
147  if (!var)
148  mooseError("Scalar variable '" + var_name + "' does not exist in this system");
149  return *var;
150 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
Class for scalar variables (they are different).

◆ getScalarVariable() [2/2]

MooseVariableScalar & SystemBase::getScalarVariable ( THREAD_ID  tid,
unsigned int  var_number 
) const
virtualinherited

Gets a reference to a variable with specified number.

Parameters
tidThread id
var_numberlibMesh variable number
Returns
reference the variable (class)

Definition at line 153 of file SystemBase.C.

154 {
155  MooseVariableScalar * var =
156  dynamic_cast<MooseVariableScalar *>(_vars[tid].getVariable(var_number));
157  if (!var)
158  mooseError("variable #" + Moose::stringify(var_number) + " does not exist in this system");
159  return *var;
160 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::string stringify(const T &t)
conversion to string
Definition: Conversion.h:64
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
Class for scalar variables (they are different).

◆ getScalarVariables()

const std::vector<MooseVariableScalar *>& SystemBase::getScalarVariables ( THREAD_ID  tid)
inlineinherited

◆ getStandardFieldVariableNames()

void SystemBase::getStandardFieldVariableNames ( std::vector< VariableName > &  std_field_variables) const
inherited

◆ getSubdomainsForVar() [1/2]

const std::set<SubdomainID>& SystemBase::getSubdomainsForVar ( unsigned int  var_number) const
inlineinherited

Definition at line 762 of file SystemBase.h.

Referenced by NonlinearSystemBase::checkKernelCoverage(), and SystemBase::getSubdomainsForVar().

763  {
764  return _var_map.at(var_number);
765  }
std::map< unsigned int, std::set< SubdomainID > > _var_map
Map of variables (variable id -> array of subdomains where it lives)
Definition: SystemBase.h:992

◆ getSubdomainsForVar() [2/2]

const std::set< SubdomainID > & SystemBase::getSubdomainsForVar ( const std::string &  var_name) const
inherited

Get the block where a variable of this system is defined.

Parameters
var_nameThe name of the variable
Returns
the set of subdomain ids where the variable is active (defined)

Definition at line 1674 of file SystemBase.C.

1675 {
1676  return getSubdomainsForVar(getVariable(0, var_name).number());
1677 }
unsigned int number() const
Gets the number of this system.
Definition: SystemBase.C:1159
const std::set< SubdomainID > & getSubdomainsForVar(unsigned int var_number) const
Definition: SystemBase.h:762
MooseVariableFieldBase & getVariable(THREAD_ID tid, const std::string &var_name) const
Gets a reference to a variable of with specified name.
Definition: SystemBase.C:89

◆ getTimeIntegrator()

const TimeIntegrator & SystemBase::getTimeIntegrator ( const unsigned int  var_num) const
inherited

Retrieve the time integrator that integrates the given variable's equation.

Definition at line 1650 of file SystemBase.C.

Referenced by AB2PredictorCorrector::estimateTimeError().

1651 {
1652  const auto * const ti = queryTimeIntegrator(var_num);
1653 
1654  if (ti)
1655  return *ti;
1656  else
1657  mooseError("No time integrator found that integrates variable number ",
1658  std::to_string(var_num));
1659 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
const TimeIntegrator * queryTimeIntegrator(const unsigned int var_num) const
Retrieve the time integrator that integrates the given variable&#39;s equation.
Definition: SystemBase.C:1640

◆ getTimeIntegrators()

const std::vector< std::shared_ptr< TimeIntegrator > > & SystemBase::getTimeIntegrators ( )
inherited
Returns
All the time integrators owned by this system

Definition at line 1662 of file SystemBase.C.

1663 {
1664  return _time_integrators;
1665 }
std::vector< std::shared_ptr< TimeIntegrator > > _time_integrators
Time integrator.
Definition: SystemBase.h:1041

◆ getVariable() [1/2]

MooseVariableFieldBase & SystemBase::getVariable ( THREAD_ID  tid,
const std::string &  var_name 
) const
inherited

Gets a reference to a variable of with specified name.

Parameters
tidThread id
var_namevariable name
Returns
reference the variable (class)

Definition at line 89 of file SystemBase.C.

Referenced by AdaptivityAction::act(), Assembly::addJacobianBlockNonlocal(), FEProblemBase::addJacobianBlockTags(), NonlocalKernel::computeNonlocalOffDiagJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), Assembly::copyFaceShapes(), Assembly::copyNeighborShapes(), Assembly::copyShapes(), SystemBase::copyVars(), DMMooseSetVariables(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), NodeElemConstraint::getConnectedDofIndices(), NodeFaceConstraint::getConnectedDofIndices(), SystemBase::getSubdomainsForVar(), ResidualObject::getVariable(), SubProblem::getVariableHelper(), Assembly::init(), NodalNormalsPreprocessor::initialize(), ExplicitTimeIntegrator::initialSetup(), ReferenceResidualConvergence::initialSetup(), LinearSystem::initialSetup(), Assembly::initNonlocalCoupling(), PNGOutput::makeMeshFunc(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), UpdateErrorVectorsThread::onElement(), Assembly::prepareBlock(), Assembly::prepareBlockNonlocal(), AddPeriodicBCAction::setPeriodicVars(), NonlinearSystemBase::setupScalingData(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

90 {
92  dynamic_cast<MooseVariableFieldBase *>(_vars[tid].getVariable(var_name));
93  if (!var)
94  mooseError("Variable '", var_name, "' does not exist in this system");
95  return *var;
96 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
This class provides an interface for common operations on field variables of both FE and FV types wit...
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ getVariable() [2/2]

MooseVariableFieldBase & SystemBase::getVariable ( THREAD_ID  tid,
unsigned int  var_number 
) const
inherited

Gets a reference to a variable with specified number.

Parameters
tidThread id
var_numberlibMesh variable number
Returns
reference the variable (class)

Definition at line 99 of file SystemBase.C.

100 {
101  if (var_number < _numbered_vars[tid].size())
102  if (_numbered_vars[tid][var_number])
103  return *_numbered_vars[tid][var_number];
104 
105  mooseError("Variable #", Moose::stringify(var_number), " does not exist in this system");
106 }
std::vector< std::vector< MooseVariableFieldBase * > > _numbered_vars
Map variable number to its pointer.
Definition: SystemBase.h:1044
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::string stringify(const T &t)
conversion to string
Definition: Conversion.h:64

◆ getVariableBlocks()

const std::set< SubdomainID > * SystemBase::getVariableBlocks ( unsigned int  var_number)
virtualinherited

Get the block where a variable of this system is defined.

Parameters
var_numberThe number of the variable
Returns
the set of subdomain ids where the variable is active (defined)

Definition at line 163 of file SystemBase.C.

Referenced by PhysicsBasedPreconditioner::addSystem().

164 {
165  mooseAssert(_var_map.find(var_number) != _var_map.end(), "Variable does not exist.");
166  if (_var_map[var_number].empty())
167  return nullptr;
168  else
169  return &_var_map[var_number];
170 }
std::map< unsigned int, std::set< SubdomainID > > _var_map
Map of variables (variable id -> array of subdomains where it lives)
Definition: SystemBase.h:992

◆ getVariableGlobalDoFs()

const std::vector<dof_id_type>& SystemBase::getVariableGlobalDoFs ( )
inlineinherited

Get the global dof indices of a variable, this needs to be called after the indices have been set by setVariableGlobalDoFs

Definition at line 843 of file SystemBase.h.

843 { return _var_all_dof_indices; }
std::vector< dof_id_type > _var_all_dof_indices
Container for the dof indices of a given variable.
Definition: SystemBase.h:1056

◆ getVariableNames()

const std::vector<VariableName>& SystemBase::getVariableNames ( ) const
inlineinherited

◆ getVariables()

const std::vector<MooseVariableFieldBase *>& SystemBase::getVariables ( THREAD_ID  tid)
inlineinherited

◆ getVector() [1/4]

virtual NumericVector<Number>& DisplacedSystem::getVector ( TagID  tag)
inlineoverridevirtual

Get a raw NumericVector by tag.

Reimplemented from SystemBase.

Definition at line 34 of file DisplacedSystem.h.

35  {
36  return _undisplaced_system.getVector(tag_id);
37  }
SystemBase & _undisplaced_system
virtual NumericVector< Number > & getVector(const std::string &name)
Get a raw NumericVector by name.
Definition: SystemBase.C:916

◆ getVector() [2/4]

virtual const NumericVector<Number>& DisplacedSystem::getVector ( TagID  tag_id) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 38 of file DisplacedSystem.h.

39  {
40  return _undisplaced_system.getVector(tag_id);
41  }
SystemBase & _undisplaced_system
virtual NumericVector< Number > & getVector(const std::string &name)
Get a raw NumericVector by name.
Definition: SystemBase.C:916

◆ getVector() [3/4]

NumericVector< Number > & DisplacedSystem::getVector ( const std::string &  name)
overridevirtual

Get a raw NumericVector by name.

Get a raw NumericVector with the given name.

Reimplemented from SystemBase.

Definition at line 38 of file DisplacedSystem.C.

39 {
40  if (_sys.have_vector(name))
41  return _sys.get_vector(name);
42  else
44 }
libMesh::System & _sys
virtual const std::string & name() const
Definition: SystemBase.C:1330
SystemBase & _undisplaced_system
bool have_vector(std::string_view vec_name) const
virtual NumericVector< Number > & getVector(const std::string &name)
Get a raw NumericVector by name.
Definition: SystemBase.C:916
const NumericVector< Number > & get_vector(std::string_view vec_name) const

◆ getVector() [4/4]

const NumericVector< Number > & DisplacedSystem::getVector ( const std::string &  name) const
overridevirtual

Reimplemented from SystemBase.

Definition at line 47 of file DisplacedSystem.C.

48 {
49  if (_sys.have_vector(name))
50  return _sys.get_vector(name);
51  else
53 }
libMesh::System & _sys
virtual const std::string & name() const
Definition: SystemBase.C:1330
SystemBase & _undisplaced_system
bool have_vector(std::string_view vec_name) const
virtual NumericVector< Number > & getVector(const std::string &name)
Get a raw NumericVector by name.
Definition: SystemBase.C:916
const NumericVector< Number > & get_vector(std::string_view vec_name) const

◆ gradientContainer()

const std::vector<std::unique_ptr<NumericVector<Number> > >& SystemBase::gradientContainer ( ) const
inlineinherited

Reference to the container vector which hold gradients at dofs (if it can be interpreted).

Mainly used for finite volume systems.

Definition at line 931 of file SystemBase.h.

932  {
933  return _raw_grad_container;
934  }
std::vector< std::unique_ptr< NumericVector< Number > > > _raw_grad_container
A cache for storing gradients at dof locations.
Definition: SystemBase.h:1065

◆ hasMatrix()

virtual bool DisplacedSystem::hasMatrix ( TagID  tag) const
inlineoverridevirtual

Check if the tagged matrix exists in the system.

Reimplemented from SystemBase.

Definition at line 215 of file DisplacedSystem.h.

216  {
217  return _undisplaced_system.hasMatrix(tag_id);
218  }
virtual bool hasMatrix(TagID tag) const
Check if the tagged matrix exists in the system.
Definition: SystemBase.h:351
SystemBase & _undisplaced_system

◆ hasScalarVariable()

bool SystemBase::hasScalarVariable ( const std::string &  var_name) const
virtualinherited

Definition at line 859 of file SystemBase.C.

Referenced by MortarScalarBase::computeJacobian(), NonlinearSystemBase::computeJacobianInternal(), ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), SystemBase::copyVars(), ExplicitTimeIntegrator::initialSetup(), NonlinearEigenSystem::postAddResidualObject(), AddPeriodicBCAction::setPeriodicVars(), and NonlinearSystemBase::setupScalingData().

860 {
861  if (system().has_variable(var_name))
862  return system().variable_type(var_name).family == SCALAR;
863  else
864  return false;
865 }
SCALAR
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
const FEType & variable_type(const unsigned int i) const

◆ hasSolutionState()

bool DisplacedSystem::hasSolutionState ( const unsigned int  state,
Moose::SolutionIterationType  iteration_type = Moose::SolutionIterationType::Time 
) const
inlineoverridevirtual

Whether or not the system has the solution state (0 = current, 1 = old, 2 = older, etc).

Reimplemented from SystemBase.

Definition at line 289 of file DisplacedSystem.h.

291 {
292  return _undisplaced_system.hasSolutionState(state, iteration_type);
293 }
SystemBase & _undisplaced_system
virtual bool hasSolutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time) const
Whether or not the system has the solution state (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.h:1081

◆ hasVarCopy()

bool SystemBase::hasVarCopy ( ) const
inlineinherited

Whether or not there are variables to be restarted from an Exodus mesh file.

Definition at line 884 of file SystemBase.h.

884 { return _var_to_copy.size() > 0; }
std::vector< VarCopyInfo > _var_to_copy
Definition: SystemBase.h:1032

◆ hasVariable()

bool SystemBase::hasVariable ( const std::string &  var_name) const
virtualinherited

Query a system for a variable.

Parameters
var_namename of the variable
Returns
true if the variable exists

Definition at line 834 of file SystemBase.C.

Referenced by ADDGKernel::ADDGKernel(), ArrayDGKernel::ArrayDGKernel(), SystemBase::copyVars(), DGKernel::DGKernel(), DMMooseSetVariables(), FEProblemBase::duplicateVariableCheck(), SubProblem::getVariableHelper(), SubProblem::hasAuxiliaryVariable(), ExplicitTimeIntegrator::initialSetup(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), PNGOutput::makeMeshFunc(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), NonlinearSystemBase::setupScalingData(), and Coupleable::writableCoupledValue().

835 {
836  auto & names = getVariableNames();
837  if (system().has_variable(var_name))
838  return system().variable_type(var_name).family != SCALAR;
839  if (std::find(names.begin(), names.end(), var_name) != names.end())
840  // array variable
841  return true;
842  else
843  return false;
844 }
SCALAR
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
const FEType & variable_type(const unsigned int i) const
const std::vector< VariableName > & getVariableNames() const
Definition: SystemBase.h:861

◆ hasVector() [1/2]

virtual bool DisplacedSystem::hasVector ( TagID  tag_id) const
inlineoverridevirtual

Check if the tagged vector exists in the system.

Reimplemented from SystemBase.

Definition at line 210 of file DisplacedSystem.h.

211  {
212  return _undisplaced_system.hasVector(tag_id);
213  }
bool hasVector(const std::string &tag_name) const
Check if the named vector exists in the system.
Definition: SystemBase.C:907
SystemBase & _undisplaced_system

◆ hasVector() [2/2]

bool SystemBase::hasVector ( const std::string &  tag_name) const
inherited

◆ initializeObjects()

virtual void SystemBase::initializeObjects ( )
inlinevirtualinherited

Called only once, just before the solve begins so objects can do some precalculations.

Definition at line 173 of file SystemBase.h.

173 {}

◆ initialSetup()

void SystemBase::initialSetup ( )
virtualinherited

Setup Functions.

Reimplemented in NonlinearSystemBase, LinearSystem, and AuxiliarySystem.

Definition at line 1525 of file SystemBase.C.

Referenced by AuxiliarySystem::initialSetup(), LinearSystem::initialSetup(), and NonlinearSystemBase::initialSetup().

1526 {
1527  for (THREAD_ID tid = 0; tid < libMesh::n_threads(); tid++)
1528  _vars[tid].initialSetup();
1529 
1530  // If we need raw gradients, we initialize them here.
1531  bool gradient_storage_initialized = false;
1532  for (const auto & field_var : _vars[0].fieldVariables())
1533  if (!gradient_storage_initialized && field_var->needsGradientVectorStorage())
1534  {
1535  _raw_grad_container.clear();
1536  for (const auto i : make_range(this->_mesh.dimension()))
1537  {
1538  libmesh_ignore(i);
1539  _raw_grad_container.push_back(currentSolution()->zero_clone());
1540  }
1541  }
1542 }
virtual const NumericVector< Number > *const & currentSolution() const =0
The solution vector that is currently being operated on.
unsigned int n_threads()
std::vector< std::unique_ptr< NumericVector< Number > > > _raw_grad_container
A cache for storing gradients at dof locations.
Definition: SystemBase.h:1065
void libmesh_ignore(const Args &...)
virtual unsigned int dimension() const
Returns MeshBase::mesh_dimension(), (not MeshBase::spatial_dimension()!) of the underlying libMesh me...
Definition: MooseMesh.C:2923
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
MooseMesh & _mesh
Definition: SystemBase.h:985
IntRange< T > make_range(T beg, T end)
virtual void initialSetup()
Setup Functions.
Definition: SystemBase.C:1525
unsigned int THREAD_ID
Definition: MooseTypes.h:209

◆ initSolutionState()

void DisplacedSystem::initSolutionState ( )
inlineoverridevirtual

Initializes the solution state.

Reimplemented from SystemBase.

Definition at line 262 of file DisplacedSystem.h.

263 {
265 }
virtual void initSolutionState()
Initializes the solution state.
Definition: SystemBase.C:1354
SystemBase & _undisplaced_system

◆ isArrayVariable()

bool SystemBase::isArrayVariable ( const std::string &  var_name) const
virtualinherited

If a variable is an array variable.

Definition at line 847 of file SystemBase.C.

848 {
849  auto & names = getVariableNames();
850  if (!system().has_variable(var_name) &&
851  std::find(names.begin(), names.end(), var_name) != names.end())
852  // array variable
853  return true;
854  else
855  return false;
856 }
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
const std::vector< VariableName > & getVariableNames() const
Definition: SystemBase.h:861

◆ isScalarVariable()

bool SystemBase::isScalarVariable ( unsigned int  var_name) const
virtualinherited

Definition at line 868 of file SystemBase.C.

Referenced by Assembly::init(), ReferenceResidualConvergence::initialSetup(), and Assembly::initNonlocalCoupling().

869 {
870  return (system().variable(var_num).type().family == SCALAR);
871 }
virtual libMesh::System & system()=0
Get the reference to the libMesh system.

◆ jacobianSetup()

void SystemBase::jacobianSetup ( )
virtualinherited

Reimplemented in NonlinearSystemBase, LinearSystem, and AuxiliarySystem.

Definition at line 1573 of file SystemBase.C.

Referenced by AuxiliarySystem::jacobianSetup(), and NonlinearSystemBase::jacobianSetup().

1574 {
1575  for (THREAD_ID tid = 0; tid < libMesh::n_threads(); tid++)
1576  _vars[tid].jacobianSetup();
1577 }
unsigned int n_threads()
virtual void jacobianSetup()
Definition: SystemBase.C:1573
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
unsigned int THREAD_ID
Definition: MooseTypes.h:209

◆ matrixTagActive()

bool SystemBase::matrixTagActive ( TagID  tag) const
virtualinherited

If or not a matrix tag is active.

Definition at line 1151 of file SystemBase.C.

1152 {
1153  mooseAssert(_subproblem.matrixTagExists(tag), "Matrix tag " << tag << " does not exist");
1154 
1155  return tag < _matrix_tag_active_flags.size() && _matrix_tag_active_flags[tag];
1156 }
std::vector< bool > _matrix_tag_active_flags
Active flags for tagged matrices.
Definition: SystemBase.h:1019
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual bool matrixTagExists(const TagName &tag_name) const
Check to see if a particular Tag exists.
Definition: SubProblem.C:328

◆ mesh() [1/2]

MooseMesh& SystemBase::mesh ( )
inlineinherited

◆ mesh() [2/2]

const MooseMesh& SystemBase::mesh ( ) const
inlineinherited

Definition at line 100 of file SystemBase.h.

100 { return _mesh; }
MooseMesh & _mesh
Definition: SystemBase.h:985

◆ name()

const std::string & SystemBase::name ( ) const
virtualinherited

Definition at line 1330 of file SystemBase.C.

Referenced by NonlinearSystemBase::addBoundaryCondition(), NonlinearSystemBase::addConstraint(), NonlinearSystemBase::addDamper(), NonlinearSystemBase::addDGKernel(), NonlinearSystemBase::addDiracKernel(), NonlinearSystemBase::addHDGKernel(), NonlinearSystemBase::addInterfaceKernel(), MooseEigenSystem::addKernel(), AuxiliarySystem::addKernel(), NonlinearSystemBase::addKernel(), SystemBase::addMatrix(), NonlinearSystemBase::addNodalKernel(), AuxiliarySystem::addScalarKernel(), NonlinearSystemBase::addScalarKernel(), NonlinearSystemBase::addSplit(), SystemBase::addTimeIntegrator(), AuxiliarySystem::addVariable(), SystemBase::addVariable(), DiffusionLHDGAssemblyHelper::checkCoupling(), SystemBase::closeTaggedVector(), LinearSystem::computeGradients(), LinearSystem::computeLinearSystemTags(), DisplacedProblem::DisplacedProblem(), SystemBase::getMatrix(), NonlinearSystemBase::getSplit(), getVector(), SystemBase::getVector(), SystemBase::hasVector(), MooseStaticCondensationPreconditioner::initialSetup(), LinearSystem::initialSetup(), Moose::PetscSupport::petscSetDefaults(), NonlinearEigenSystem::postAddResidualObject(), SystemBase::removeMatrix(), SystemBase::removeVector(), SystemBase::solutionState(), LinearSystem::solve(), LinearTimeIntegratorInterface::timeDerivativeMatrixContribution(), LinearTimeIntegratorInterface::timeDerivativeRHSContribution(), and SystemBase::zeroTaggedVector().

1331 {
1332  return system().name();
1333 }
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
const std::string & name() const

◆ needSolutionState()

void DisplacedSystem::needSolutionState ( const unsigned int  state,
Moose::SolutionIterationType  iteration_type = Moose::SolutionIterationType::Time 
)
inlineoverridevirtual

Registers that the solution state state is needed.

Reimplemented from SystemBase.

Definition at line 282 of file DisplacedSystem.h.

284 {
285  _undisplaced_system.needSolutionState(state, iteration_type);
286 }
virtual void needSolutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Registers that the solution state state is needed.
Definition: SystemBase.C:1428
SystemBase & _undisplaced_system

◆ nFieldVariables()

unsigned int SystemBase::nFieldVariables ( ) const
inherited

Get the number of field variables in this system.

Returns
the number of field variables

Definition at line 883 of file SystemBase.C.

Referenced by SystemBase::nVariables().

884 {
885  unsigned int n = 0;
886  for (auto & var : _vars[0].fieldVariables())
887  n += var->count();
888 
889  return n;
890 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ nFVVariables()

unsigned int SystemBase::nFVVariables ( ) const
inherited

Get the number of finite volume variables in this system.

Returns
the number of finite volume variables

Definition at line 893 of file SystemBase.C.

894 {
895  unsigned int n = 0;
896  for (auto & var : _vars[0].fieldVariables())
897  if (var->isFV())
898  n += var->count();
899 
900  return n;
901 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ nonTimeVectorTag()

virtual TagID DisplacedSystem::nonTimeVectorTag ( ) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 52 of file DisplacedSystem.h.

SystemBase & _undisplaced_system
virtual TagID nonTimeVectorTag() const
Definition: SystemBase.h:293

◆ number()

unsigned int SystemBase::number ( ) const
inherited

Gets the number of this system.

Returns
The number of this system

Definition at line 1159 of file SystemBase.C.

Referenced by SetupResidualDebugAction::act(), FEProblemBase::addCachedResidualDirectly(), FEProblemBase::addJacobian(), FEProblemBase::addJacobianBlockTags(), FEProblemBase::addJacobianLowerD(), FEProblemBase::addJacobianNeighbor(), FEProblemBase::addJacobianNeighborLowerD(), FEProblemBase::addJacobianOffDiagScalar(), FEProblemBase::addJacobianScalar(), FEProblemBase::addResidual(), FEProblemBase::addResidualLower(), FEProblemBase::addResidualNeighbor(), FEProblemBase::addResidualScalar(), SystemBase::addScalingVector(), ADKernelTempl< T >::ADKernelTempl(), ElementSubdomainModifierBase::applyIC(), ArrayKernel::ArrayKernel(), NonlinearSystemBase::assembleScalingVector(), NonlinearEigenSystem::attachPreconditioner(), DiffusionLHDGAssemblyHelper::checkCoupling(), SolverSystem::compute(), MooseVariableScalar::computeAD(), FEProblemBase::computeBounds(), Assembly::computeFaceMap(), InternalSideIndicatorBase::computeIndicator(), ArrayNodalBC::computeJacobian(), VectorNodalBC::computeJacobian(), NodalBC::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVFluxBC::computeJacobian(), FVFluxKernel::computeJacobian(), FVInterfaceKernel::computeJacobian(), FEProblemBase::computeJacobianBlock(), NonlinearSystemBase::computeJacobianInternal(), FEProblemBase::computeJacobianTags(), LinearSystem::computeLinearSystemInternal(), FEProblemBase::computeNearNullSpace(), NonlinearSystemBase::computeNodalBCsResidualAndJacobian(), FEProblemBase::computeNullSpace(), VectorNodalBC::computeOffDiagJacobian(), ArrayNodalBC::computeOffDiagJacobian(), NodalBC::computeOffDiagJacobian(), NodalKernel::computeOffDiagJacobian(), ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), ComputeFullJacobianThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInternalFace(), FEProblemBase::computePostCheck(), FVOrthogonalBoundaryDiffusion::computeQpResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), FVFluxKernel::computeResidual(), FVInterfaceKernel::computeResidual(), Kernel::computeResidualAndJacobian(), NodalBC::computeResidualAndJacobian(), IntegratedBC::computeResidualAndJacobian(), FEProblemBase::computeResidualAndJacobian(), NonlinearSystemBase::computeResidualAndJacobianInternal(), NonlinearSystemBase::computeResidualInternal(), FEProblemBase::computeResidualL2Norm(), NonlinearSystemBase::computeResidualTags(), NonlinearSystemBase::computeScaling(), Assembly::computeSinglePointMapAD(), FEProblemBase::computeTransposeNullSpace(), DebugResidualAux::computeValue(), NearestNodeValueAux::computeValue(), SlepcEigenSolverConfiguration::configure_solver(), NonlinearSystemBase::constraintJacobians(), LinearSystem::containsTimeKernel(), Coupleable::coupled(), FEProblemBase::currentLinearSysNum(), FEProblemBase::currentNlSysNum(), PseudoTimestep::currentResidualNorm(), ComputeResidualThread::determineObjectWarehouses(), ComputeResidualAndJacobianThread::determineObjectWarehouses(), Moose::doDerivatives(), VariableResidual::execute(), GreaterThanLessThanPostprocessor::execute(), NodalNormalsCorner::execute(), NodalNormalsEvaluator::execute(), NodalNormalsPreprocessor::execute(), ExplicitTimeIntegrator::ExplicitTimeIntegrator(), InternalSideIndicatorBase::finalize(), NumNonlinearIterations::finalize(), BoundsBase::getDoFIndex(), NonlinearSystemBase::getNodeDofs(), NonlinearEigenSystem::getSNES(), SystemBase::getSubdomainsForVar(), NumLinearIterations::getValue(), NumResidualEvaluations::getValue(), Residual::getValue(), Moose::globalDofIndexToDerivative(), FVBoundaryCondition::hasFaceSide(), ExplicitTimeIntegrator::init(), ExplicitTimeIntegrator::initialSetup(), NonlinearSystemBase::initialSetup(), ActivateElementsUserObjectBase::initSolutions(), EigenExecutionerBase::inversePowerIteration(), Kernel::Kernel(), Moose::SlepcSupport::mooseSlepcEigenFormFunctionA(), Moose::SlepcSupport::mooseSlepcEigenFormFunctionAB(), Moose::SlepcSupport::mooseSlepcEigenFormFunctionB(), Moose::SlepcSupport::mooseSlepcEigenFormJacobianA(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), MooseVariableInterface< Real >::MooseVariableInterface(), EigenExecutionerBase::nonlinearSolve(), ComputeDiracThread::onElement(), ComputeNodalKernelBCJacobiansThread::onNode(), ComputeNodalKernelJacobiansThread::onNode(), VariableResidualNormsDebugOutput::output(), Moose::PetscSupport::petscLinearConverged(), Moose::PetscSupport::petscNonlinearConverged(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), ComputeJacobianThread::postElement(), FEProblemBase::prepareAssembly(), SystemBase::prepareFace(), FEProblemBase::prepareFaceShapes(), FEProblemBase::prepareNeighborShapes(), FEProblemBase::prepareShapes(), FEProblemBase::reinitDirac(), FEProblemBase::reinitOffDiagScalars(), NonlinearSystem::residualAndJacobianTogether(), FEProblemBase::setResidual(), FEProblemBase::setResidualNeighbor(), PhysicsBasedPreconditioner::setup(), FVInterfaceKernel::setupData(), NonlinearSystemBase::shouldEvaluatePreSMOResidual(), ActuallyExplicitEuler::solve(), NonlinearEigenSystem::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), ExplicitSSPRungeKutta::solveStage(), NonlinearThread::subdomainChanged(), UserObject::systemNumber(), MultiAppDofCopyTransfer::transferDofObject(), FVFluxBC::uOnGhost(), FVFluxBC::uOnUSub(), FVFluxBC::updateCurrentFace(), and MortarConstraintBase::zeroInactiveLMDofs().

1160 {
1161  return system().number();
1162 }
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
unsigned int number() const

◆ nVariables()

unsigned int SystemBase::nVariables ( ) const
virtualinherited

Get the number of variables in this system.

Returns
the number of variables

Definition at line 874 of file SystemBase.C.

Referenced by AdaptivityAction::act(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), NonlinearSystemBase::getNodeDofs(), Assembly::init(), ExplicitTimeIntegrator::initialSetup(), MaxVarNDofsPerElem::onElement(), MaxVarNDofsPerNode::onNode(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), and AuxiliarySystem::variableWiseRelativeSolutionDifferenceNorm().

875 {
876  unsigned int n = nFieldVariables();
877  n += _vars[0].scalars().size();
878 
879  return n;
880 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
unsigned int nFieldVariables() const
Get the number of field variables in this system.
Definition: SystemBase.C:883

◆ operator=()

DisplacedSystem& DisplacedSystem::operator= ( DisplacedSystem &&  )
delete

◆ postInit()

virtual void SystemBase::postInit ( )
inlinevirtualinherited

Reimplemented in NonlinearEigenSystem.

Definition at line 162 of file SystemBase.h.

Referenced by NonlinearEigenSystem::postInit().

162 {}

◆ prefix()

std::string SystemBase::prefix ( ) const
inherited
Returns
A prefix for solvers

Definition at line 1680 of file SystemBase.C.

Referenced by MoosePreconditioner::initialSetup().

1681 {
1682  return "-" + (system().prefix_with_name() ? system().prefix() : "");
1683 }
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
std::string prefix() const
void prefix_with_name(bool value)

◆ preInit()

virtual void SystemBase::preInit ( )
inlinevirtualinherited

This is called prior to the libMesh system has been init'd.

MOOSE system wrappers can use this method to add vectors and matrices to the libMesh system

Reimplemented in NonlinearSystemBase, and SolverSystem.

Definition at line 156 of file SystemBase.h.

Referenced by SolverSystem::preInit().

156 {}

◆ prepare()

void SystemBase::prepare ( THREAD_ID  tid)
virtualinherited

Prepare the system for use.

Parameters
tidID of the thread

Definition at line 255 of file SystemBase.C.

Referenced by SubProblem::reinitElemFaceRef().

256 {
258  {
259  const std::set<MooseVariableFieldBase *> & active_elemental_moose_variables =
261  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
262  for (const auto & var : vars)
263  var->clearDofIndices();
264 
265  for (const auto & var : active_elemental_moose_variables)
266  if (&(var->sys()) == this)
267  var->prepare();
268  }
269  else
270  {
271  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
272  for (const auto & var : vars)
273  var->prepare();
274  }
275 }
char ** vars
virtual const std::set< MooseVariableFieldBase * > & getActiveElementalMooseVariables(const THREAD_ID tid) const
Get the MOOSE variables to be reinited on each element.
Definition: SubProblem.C:454
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
virtual bool hasActiveElementalMooseVariables(const THREAD_ID tid) const
Whether or not a list of active elemental moose variables has been set.
Definition: SubProblem.C:460

◆ prepareFace()

void SystemBase::prepareFace ( THREAD_ID  tid,
bool  resize_data 
)
virtualinherited

Prepare the system for use on sides.

This will try to reuse the preparation done on the element.

Parameters
tidID of the thread
resize_dataPass True if this system needs to resize residual and jacobian datastructures based on preparing this face

Definition at line 278 of file SystemBase.C.

279 {
280  // We only need to do something if the element prepare was restricted
282  {
283  const std::set<MooseVariableFieldBase *> & active_elemental_moose_variables =
285 
286  std::vector<MooseVariableFieldBase *> newly_prepared_vars;
287 
288  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
289  for (const auto & var : vars)
290  {
291  mooseAssert(&var->sys() == this,
292  "I will cry if we store variables in our warehouse that don't belong to us");
293 
294  // If it wasn't in the active list, we need to prepare it. This has the potential to duplicate
295  // prepare if we have these conditions:
296  //
297  // 1. We have a displaced problem
298  // 2. We are using AD
299  // 3. We are not using global AD indexing
300  //
301  // But I think I would rather risk duplicate prepare than introduce an additional member set
302  // variable for tracking prepared variables. Set insertion is slow and some simulations have a
303  // ton of variables
304  if (!active_elemental_moose_variables.count(var))
305  {
306  var->prepare();
307  newly_prepared_vars.push_back(var);
308  }
309  }
310 
311  // Make sure to resize the residual and jacobian datastructures for all the new variables
312  if (resize_data)
313  for (const auto var_ptr : newly_prepared_vars)
314  {
315  _subproblem.assembly(tid, number()).prepareVariable(var_ptr);
318  }
319  }
320 }
virtual bool checkNonlocalCouplingRequirement() const =0
char ** vars
virtual const std::set< MooseVariableFieldBase * > & getActiveElementalMooseVariables(const THREAD_ID tid) const
Get the MOOSE variables to be reinited on each element.
Definition: SubProblem.C:454
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
unsigned int number() const
Gets the number of this system.
Definition: SystemBase.C:1159
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
void prepareVariableNonlocal(MooseVariableFieldBase *var)
Definition: Assembly.C:2777
virtual Assembly & assembly(const THREAD_ID tid, const unsigned int sys_num)=0
void prepareVariable(MooseVariableFieldBase *var)
Used for preparing the dense residual and jacobian blocks for one particular variable.
Definition: Assembly.C:2749
virtual bool hasActiveElementalMooseVariables(const THREAD_ID tid) const
Whether or not a list of active elemental moose variables has been set.
Definition: SubProblem.C:460

◆ prepareLowerD()

void SystemBase::prepareLowerD ( THREAD_ID  tid)
virtualinherited

Prepare the system for use for lower dimensional elements.

Parameters
tidID of the thread

Definition at line 331 of file SystemBase.C.

Referenced by SubProblem::reinitLowerDElem().

332 {
333  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
334  for (const auto & var : vars)
335  var->prepareLowerD();
336 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ prepareNeighbor()

void SystemBase::prepareNeighbor ( THREAD_ID  tid)
virtualinherited

Prepare the system for use.

Parameters
tidID of the thread

Definition at line 323 of file SystemBase.C.

Referenced by SubProblem::reinitNeighborFaceRef().

324 {
325  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
326  for (const auto & var : vars)
327  var->prepareNeighbor();
328 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ queryTimeIntegrator()

const TimeIntegrator * SystemBase::queryTimeIntegrator ( const unsigned int  var_num) const
inherited

Retrieve the time integrator that integrates the given variable's equation.

If no suitable time integrator is found (this could happen for instance if we're solving a non-transient problem), then a nullptr will be returned

Definition at line 1640 of file SystemBase.C.

Referenced by SystemBase::getTimeIntegrator(), HDGKernel::HDGKernel(), and MooseVariableData< OutputType >::MooseVariableData().

1641 {
1642  for (auto & ti : _time_integrators)
1643  if (ti->integratesVar(var_num))
1644  return ti.get();
1645 
1646  return nullptr;
1647 }
std::vector< std::shared_ptr< TimeIntegrator > > _time_integrators
Time integrator.
Definition: SystemBase.h:1041

◆ reinit()

virtual void SystemBase::reinit ( )
inlinevirtualinherited

Reinitialize the system when the degrees of freedom in this system have changed.

This is called after the libMesh system has been reinit'd

Reimplemented in NonlinearEigenSystem.

Definition at line 168 of file SystemBase.h.

Referenced by NonlinearEigenSystem::reinit().

168 {}

◆ reinitElem()

void SystemBase::reinitElem ( const Elem elem,
THREAD_ID  tid 
)
virtualinherited

Reinit an element assembly info.

Parameters
elemWhich element we are reinitializing for
tidID of the thread

Reimplemented in AuxiliarySystem.

Definition at line 339 of file SystemBase.C.

340 {
342  {
343  const std::set<MooseVariableFieldBase *> & active_elemental_moose_variables =
345  for (const auto & var : active_elemental_moose_variables)
346  if (&(var->sys()) == this)
347  var->computeElemValues();
348  }
349  else
350  {
351  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
352  for (const auto & var : vars)
353  var->computeElemValues();
354  }
355 }
char ** vars
virtual const std::set< MooseVariableFieldBase * > & getActiveElementalMooseVariables(const THREAD_ID tid) const
Get the MOOSE variables to be reinited on each element.
Definition: SubProblem.C:454
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
virtual bool hasActiveElementalMooseVariables(const THREAD_ID tid) const
Whether or not a list of active elemental moose variables has been set.
Definition: SubProblem.C:460

◆ reinitElemFace()

void SystemBase::reinitElemFace ( const Elem elem,
unsigned int  side,
THREAD_ID  tid 
)
virtualinherited

Reinit assembly info for a side of an element.

Parameters
elemThe element
sideSide of of the element
tidThread ID

Reimplemented in AuxiliarySystem.

Definition at line 358 of file SystemBase.C.

Referenced by SubProblem::reinitElemFaceRef().

359 {
360  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
361  for (const auto & var : vars)
362  var->computeElemValuesFace();
363 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ reinitLowerD()

void SystemBase::reinitLowerD ( THREAD_ID  tid)
virtualinherited

Compute the values of the variables on the lower dimensional element.

Definition at line 382 of file SystemBase.C.

Referenced by SubProblem::reinitLowerDElem().

383 {
384  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
385  for (const auto & var : vars)
386  var->computeLowerDValues();
387 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ reinitNeighbor()

void SystemBase::reinitNeighbor ( const Elem elem,
THREAD_ID  tid 
)
virtualinherited

Compute the values of the variables at all the current points.

Definition at line 374 of file SystemBase.C.

375 {
376  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
377  for (const auto & var : vars)
378  var->computeNeighborValues();
379 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ reinitNeighborFace()

void SystemBase::reinitNeighborFace ( const Elem elem,
unsigned int  side,
THREAD_ID  tid 
)
virtualinherited

Compute the values of the variables at all the current points.

Definition at line 366 of file SystemBase.C.

Referenced by SubProblem::reinitNeighborFaceRef().

367 {
368  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
369  for (const auto & var : vars)
370  var->computeNeighborValuesFace();
371 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ reinitNode()

void SystemBase::reinitNode ( const Node node,
THREAD_ID  tid 
)
virtualinherited

Reinit nodal assembly info.

Parameters
nodeNode to reinit for
tidThread ID

Definition at line 390 of file SystemBase.C.

391 {
392  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
393  for (const auto & var : vars)
394  {
395  var->reinitNode();
396  if (var->isNodalDefined())
397  var->computeNodalValues();
398  }
399 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ reinitNodeFace()

void SystemBase::reinitNodeFace ( const Node node,
BoundaryID  bnd_id,
THREAD_ID  tid 
)
virtualinherited

Reinit nodal assembly info on a face.

Parameters
nodeNode to reinit
bnd_idBoundary ID
tidThread ID

Definition at line 402 of file SystemBase.C.

403 {
404  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
405  for (const auto & var : vars)
406  {
407  var->reinitNode();
408  if (var->isNodalDefined())
409  var->computeNodalValues();
410  }
411 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ reinitNodes()

void SystemBase::reinitNodes ( const std::vector< dof_id_type > &  nodes,
THREAD_ID  tid 
)
virtualinherited

Reinit variables at a set of nodes.

Parameters
nodesList of node ids to reinit
tidThread ID

Definition at line 414 of file SystemBase.C.

415 {
416  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
417  for (const auto & var : vars)
418  {
419  var->reinitNodes(nodes);
420  var->computeNodalValues();
421  }
422 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ reinitNodesNeighbor()

void SystemBase::reinitNodesNeighbor ( const std::vector< dof_id_type > &  nodes,
THREAD_ID  tid 
)
virtualinherited

Reinit variables at a set of neighbor nodes.

Parameters
nodesList of node ids to reinit
tidThread ID

Definition at line 425 of file SystemBase.C.

426 {
427  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
428  for (const auto & var : vars)
429  {
430  var->reinitNodesNeighbor(nodes);
431  var->computeNodalNeighborValues();
432  }
433 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ reinitScalars()

void SystemBase::reinitScalars ( THREAD_ID  tid,
bool  reinit_for_derivative_reordering = false 
)
virtualinherited

Reinit scalar varaibles.

Parameters
tidThread ID
reinit_for_derivative_reorderingA flag indicating whether we are reinitializing for the purpose of re-ordering derivative information for ADNodalBCs

Definition at line 436 of file SystemBase.C.

437 {
438  const std::vector<MooseVariableScalar *> & vars = _vars[tid].scalars();
439  for (const auto & var : vars)
440  var->reinit(reinit_for_derivative_reordering);
441 }
char ** vars
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ removeMatrix()

void SystemBase::removeMatrix ( TagID  tag)
inherited

Removes a matrix with a given tag.

Parameters
tag_nameThe name of the tag

Definition at line 582 of file SystemBase.C.

583 {
584  if (!_subproblem.matrixTagExists(tag_id))
585  mooseError("Cannot remove the matrix with TagID ",
586  tag_id,
587  "\nin system '",
588  name(),
589  "', because that tag does not exist in the problem");
590 
591  if (hasMatrix(tag_id))
592  {
593  const auto matrix_name = _subproblem.matrixTagName(tag_id);
594  system().remove_matrix(matrix_name);
595  _tagged_matrices[tag_id] = nullptr;
596  }
597 }
std::vector< libMesh::SparseMatrix< Number > * > _tagged_matrices
Tagged matrices (pointer)
Definition: SystemBase.h:1017
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
virtual bool hasMatrix(TagID tag) const
Check if the tagged matrix exists in the system.
Definition: SystemBase.h:351
virtual const std::string & name() const
Definition: SystemBase.C:1330
void remove_matrix(std::string_view mat_name)
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual bool matrixTagExists(const TagName &tag_name) const
Check to see if a particular Tag exists.
Definition: SubProblem.C:328
virtual TagName matrixTagName(TagID tag)
Retrieve the name associated with a TagID.
Definition: SubProblem.C:357

◆ removeVector() [1/2]

void SystemBase::removeVector ( const std::string &  name)
inherited

Remove a vector from the system with the given name.

Definition at line 1324 of file SystemBase.C.

Referenced by SystemBase::restoreOldSolutions().

1325 {
1327 }
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
virtual const std::string & name() const
Definition: SystemBase.C:1330
void remove_vector(std::string_view vec_name)

◆ removeVector() [2/2]

void SystemBase::removeVector ( TagID  tag_id)
inherited

Remove a solution length vector from the system with the specified TagID.

Parameters
tag_idTag ID

Definition at line 692 of file SystemBase.C.

693 {
694  if (!_subproblem.vectorTagExists(tag_id))
695  mooseError("Cannot remove the vector with TagID ",
696  tag_id,
697  "\nin system '",
698  name(),
699  "', because that tag does not exist in the problem");
700 
701  if (hasVector(tag_id))
702  {
703  auto vector_name = _subproblem.vectorTagName(tag_id);
704  system().remove_vector(vector_name);
705  _tagged_vectors[tag_id] = nullptr;
706  }
707 }
bool hasVector(const std::string &tag_name) const
Check if the named vector exists in the system.
Definition: SystemBase.C:907
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
virtual const std::string & name() const
Definition: SystemBase.C:1330
void remove_vector(std::string_view vec_name)
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual bool vectorTagExists(const TagID tag_id) const
Check to see if a particular Tag exists.
Definition: SubProblem.h:201
virtual TagName vectorTagName(const TagID tag) const
Retrieve the name associated with a TagID.
Definition: SubProblem.C:221
std::vector< NumericVector< Number > * > _tagged_vectors
Tagged vectors (pointer)
Definition: SystemBase.h:1015

◆ residualCopy()

virtual NumericVector<Number>& DisplacedSystem::residualCopy ( )
inlineoverridevirtual

Return the residual copy from the NonlinearSystem.

Returns
Residual copy

Reimplemented from SystemBase.

Definition at line 160 of file DisplacedSystem.h.

161  {
163  }
virtual NumericVector< Number > & residualCopy()
Definition: SystemBase.h:427
SystemBase & _undisplaced_system

◆ residualGhosted()

virtual NumericVector<Number>& DisplacedSystem::residualGhosted ( )
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 164 of file DisplacedSystem.h.

165  {
167  }
SystemBase & _undisplaced_system
virtual NumericVector< Number > & residualGhosted()
Definition: SystemBase.h:431

◆ residualSetup()

void SystemBase::residualSetup ( )
virtualinherited

Reimplemented in NonlinearSystemBase, LinearSystem, and AuxiliarySystem.

Definition at line 1566 of file SystemBase.C.

Referenced by AuxiliarySystem::residualSetup(), and NonlinearSystemBase::residualSetup().

1567 {
1568  for (THREAD_ID tid = 0; tid < libMesh::n_threads(); tid++)
1569  _vars[tid].residualSetup();
1570 }
unsigned int n_threads()
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
virtual void residualSetup()
Definition: SystemBase.C:1566
unsigned int THREAD_ID
Definition: MooseTypes.h:209

◆ residualVectorTag()

virtual TagID DisplacedSystem::residualVectorTag ( ) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 43 of file DisplacedSystem.h.

44  {
46  }
SystemBase & _undisplaced_system
virtual TagID residualVectorTag() const
Definition: SystemBase.h:298

◆ restoreOldSolutions()

void SystemBase::restoreOldSolutions ( )
virtualinherited

Restore the old and older solutions when the saved solutions present.

Definition at line 534 of file SystemBase.C.

535 {
536  const auto states =
537  _solution_states[static_cast<unsigned short>(Moose::SolutionIterationType::Time)].size();
538  if (states > 1)
539  for (unsigned int i = 1; i <= states - 1; ++i)
540  if (_saved_solution_states[i])
541  {
543  removeVector("save_solution_state_" + std::to_string(i));
544  _saved_solution_states[i] = nullptr;
545  }
546 
548  {
550  removeVector("save_solution_dot_old");
551  _saved_dot_old = nullptr;
552  }
554  {
556  removeVector("save_solution_dotdot_old");
557  _saved_dotdot_old = nullptr;
558  }
559 }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419
virtual NumericVector< Number > * solutionUDotDotOld()
Definition: SystemBase.h:255
virtual NumericVector< Number > * solutionUDotOld()
Definition: SystemBase.h:254
NumericVector< Real > * _saved_dot_old
Definition: SystemBase.h:1026
void removeVector(const std::string &name)
Remove a vector from the system with the given name.
Definition: SystemBase.C:1324
std::array< std::vector< NumericVector< Number > * >, 2 > _solution_states
The solution states (0 = current, 1 = old, 2 = older, etc)
Definition: SystemBase.h:1075
NumericVector< Real > * _saved_dotdot_old
Definition: SystemBase.h:1027
std::vector< NumericVector< Number > * > _saved_solution_states
The saved solution states (0 = current, 1 = old, 2 = older, etc)
Definition: SystemBase.h:1077

◆ restoreSolutions()

void SystemBase::restoreSolutions ( )
virtualinherited

Restore current solutions (call after your solve failed)

Reimplemented in SolverSystem.

Definition at line 1307 of file SystemBase.C.

Referenced by SolverSystem::restoreSolutions().

1308 {
1309  if (!hasSolutionState(1))
1310  mooseError("Cannot restore solutions without old solution");
1311 
1312  *(const_cast<NumericVector<Number> *&>(currentSolution())) = solutionOld();
1313  solution() = solutionOld();
1314  if (solutionUDotOld())
1315  *solutionUDot() = *solutionUDotOld();
1316  if (solutionUDotDotOld())
1318  if (solutionPreviousNewton())
1320  system().update();
1321 }
virtual const NumericVector< Number > *const & currentSolution() const =0
The solution vector that is currently being operated on.
NumericVector< Number > & solution()
Definition: SystemBase.h:195
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
virtual NumericVector< Number > * solutionUDotDotOld()
Definition: SystemBase.h:255
virtual NumericVector< Number > * solutionUDot()
Definition: SystemBase.h:252
virtual NumericVector< Number > * solutionUDotOld()
Definition: SystemBase.h:254
virtual bool hasSolutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time) const
Whether or not the system has the solution state (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.h:1081
virtual void update()
virtual const NumericVector< Number > * solutionPreviousNewton() const
Definition: SystemBase.C:1345
virtual NumericVector< Number > * solutionUDotDot()
Definition: SystemBase.h:253
NumericVector< Number > & solutionOld()
Definition: SystemBase.h:196

◆ saveOldSolutions()

void SystemBase::saveOldSolutions ( )
virtualinherited

Save the old and older solutions.

Definition at line 502 of file SystemBase.C.

503 {
504  const auto states =
505  _solution_states[static_cast<unsigned short>(Moose::SolutionIterationType::Time)].size();
506  if (states > 1)
507  {
508  _saved_solution_states.resize(states);
509  for (unsigned int i = 1; i <= states - 1; ++i)
510  if (!_saved_solution_states[i])
512  &addVector("save_solution_state_" + std::to_string(i), false, PARALLEL);
513 
514  for (unsigned int i = 1; i <= states - 1; ++i)
516  }
517 
519  _saved_dot_old = &addVector("save_solution_dot_old", false, PARALLEL);
521  _saved_dotdot_old = &addVector("save_solution_dotdot_old", false, PARALLEL);
522 
523  if (solutionUDotOld())
525 
526  if (solutionUDotDotOld())
528 }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419
virtual NumericVector< Number > * solutionUDotDotOld()
Definition: SystemBase.h:255
NumericVector< Number > & addVector(const std::string &vector_name, const bool project, const libMesh::ParallelType type)
Adds a solution length vector to the system.
virtual NumericVector< Number > * solutionUDotOld()
Definition: SystemBase.h:254
NumericVector< Real > * _saved_dot_old
Definition: SystemBase.h:1026
std::array< std::vector< NumericVector< Number > * >, 2 > _solution_states
The solution states (0 = current, 1 = old, 2 = older, etc)
Definition: SystemBase.h:1075
NumericVector< Real > * _saved_dotdot_old
Definition: SystemBase.h:1027
std::vector< NumericVector< Number > * > _saved_solution_states
The saved solution states (0 = current, 1 = old, 2 = older, etc)
Definition: SystemBase.h:1077

◆ serializedSolution()

virtual NumericVector<Number>& DisplacedSystem::serializedSolution ( )
inlineoverridevirtual

Returns a reference to a serialized version of the solution vector for this subproblem.

Reimplemented from SystemBase.

Definition at line 106 of file DisplacedSystem.h.

107  {
109  }
virtual NumericVector< Number > & serializedSolution()
Returns a reference to a serialized version of the solution vector for this subproblem.
Definition: SystemBase.C:1613
SystemBase & _undisplaced_system

◆ setActiveScalarVariableCoupleableVectorTags()

void SystemBase::setActiveScalarVariableCoupleableVectorTags ( const std::set< TagID > &  vtags,
THREAD_ID  tid 
)
inherited

Set the active vector tags for the scalar variables.

Definition at line 1593 of file SystemBase.C.

Referenced by SubProblem::setActiveScalarVariableCoupleableVectorTags().

1595 {
1596  _vars[tid].setActiveScalarVariableCoupleableVectorTags(vtags);
1597 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ setActiveVariableCoupleableVectorTags()

void SystemBase::setActiveVariableCoupleableVectorTags ( const std::set< TagID > &  vtags,
THREAD_ID  tid 
)
inherited

Set the active vector tags for the variables.

Definition at line 1587 of file SystemBase.C.

Referenced by SubProblem::setActiveFEVariableCoupleableVectorTags().

1588 {
1589  _vars[tid].setActiveVariableCoupleableVectorTags(vtags);
1590 }
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990

◆ setVariableGlobalDoFs()

void SystemBase::setVariableGlobalDoFs ( const std::string &  var_name)
inherited

set all the global dof indices for a variable

Parameters
var_nameThe name of the variable

Definition at line 185 of file SystemBase.C.

186 {
187  AllLocalDofIndicesThread aldit(_subproblem, {var_name});
189  Threads::parallel_reduce(elem_range, aldit);
190 
191  // Gather the dof indices across procs to get all the dof indices for var_name
192  aldit.dofIndicesSetUnion();
193 
194  const auto & all_dof_indices = aldit.getDofIndices();
195  _var_all_dof_indices.assign(all_dof_indices.begin(), all_dof_indices.end());
196 }
libMesh::ConstElemRange * getActiveLocalElementRange()
Return pointers to range objects for various types of ranges (local nodes, boundary elems...
Definition: MooseMesh.C:1235
std::vector< dof_id_type > _var_all_dof_indices
Container for the dof indices of a given variable.
Definition: SystemBase.h:1056
void parallel_reduce(const Range &range, Body &body, const Partitioner &)
Grab all the (possibly semi)local dof indices for the variables passed in, in the system passed in...
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
MooseMesh & _mesh
Definition: SystemBase.h:985

◆ setVerboseFlag()

void SystemBase::setVerboseFlag ( const bool &  verbose)
inlineinherited

Sets the verbose flag.

Parameters
[in]verboseVerbose flag

Definition at line 134 of file SystemBase.h.

Referenced by Executioner::Executioner().

134 { _verbose = verbose; }
bool _verbose
True if printing out additional information.
Definition: SystemBase.h:1050

◆ solution() [1/2]

NumericVector<Number>& SystemBase::solution ( )
inlineinherited

Definition at line 195 of file SystemBase.h.

Referenced by Adaptivity::adaptMesh(), TransientMultiApp::appTransferVector(), MooseEigenSystem::combineSystemSolution(), NonlinearSystemBase::computeDamping(), AuxiliarySystem::computeElementalVarsHelper(), NonlinearSystemBase::computeJacobianInternal(), AuxiliarySystem::computeMortarNodalVars(), NonlinearSystemBase::computeNodalBCs(), AuxiliarySystem::computeNodalVarsHelper(), NonlinearSystemBase::computeResidualTags(), AuxiliarySystem::computeScalarVars(), NonlinearSystemBase::constraintResiduals(), SystemBase::copyVars(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), NodalNormalsCorner::execute(), NodalNormalsEvaluator::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), NodalNormalsPreprocessor::execute(), NodalNormalsCorner::finalize(), NodalNormalsEvaluator::finalize(), NodalNormalsPreprocessor::finalize(), NodalNormalsEvaluator::initialize(), NodalNormalsCorner::initialize(), NodalNormalsPreprocessor::initialize(), MooseEigenSystem::initSystemSolution(), ComputeMarkerThread::onElement(), ComputeIndicatorThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeNodalUserObjectsThread::onNode(), FEProblemBase::projectInitialConditionOnCustomRange(), FEProblemBase::projectSolution(), Transient::relativeSolutionDifferenceNorm(), MultiApp::restore(), SystemBase::restoreSolutions(), SecantSolve::saveVariableValues(), SteffensenSolve::saveVariableValues(), PicardSolve::saveVariableValues(), MooseEigenSystem::scaleSystemSolution(), AuxiliarySystem::serializeSolution(), NonlinearSystemBase::setConstraintSecondaryValues(), NonlinearSystemBase::setInitialSolution(), solutionInternal(), NonlinearEigenSystem::solve(), MultiAppDofCopyTransfer::transfer(), SecantSolve::transformVariables(), SteffensenSolve::transformVariables(), PicardSolve::transformVariables(), AuxiliarySystem::variableWiseRelativeSolutionDifferenceNorm(), and SystemBase::zeroVariables().

195 { return solutionState(0); }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419

◆ solution() [2/2]

const NumericVector<Number>& SystemBase::solution ( ) const
inlineinherited

Definition at line 198 of file SystemBase.h.

198 { return solutionState(0); }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419

◆ solutionInternal()

NumericVector<Number>& DisplacedSystem::solutionInternal ( ) const
inlineoverrideprotectedvirtual

Internal getter for solution owned by libMesh.

Implements SystemBase.

Definition at line 252 of file DisplacedSystem.h.

253  {
254  return _undisplaced_system.solution();
255  }
NumericVector< Number > & solution()
Definition: SystemBase.h:195
SystemBase & _undisplaced_system

◆ solutionOld() [1/2]

NumericVector<Number>& SystemBase::solutionOld ( )
inlineinherited

◆ solutionOld() [2/2]

const NumericVector<Number>& SystemBase::solutionOld ( ) const
inlineinherited

Definition at line 199 of file SystemBase.h.

199 { return solutionState(1); }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419

◆ solutionOlder() [1/2]

NumericVector<Number>& SystemBase::solutionOlder ( )
inlineinherited

Definition at line 197 of file SystemBase.h.

Referenced by MooseEigenSystem::combineSystemSolution(), CentralDifference::computeTimeDerivatives(), ActivateElementsUserObjectBase::initSolutions(), MooseVariableScalar::reinit(), and ElementSubdomainModifierBase::setOldAndOlderSolutions().

197 { return solutionState(2); }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419

◆ solutionOlder() [2/2]

const NumericVector<Number>& SystemBase::solutionOlder ( ) const
inlineinherited

Definition at line 200 of file SystemBase.h.

200 { return solutionState(2); }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419

◆ solutionPreviousNewton() [1/2]

NumericVector<Number>* DisplacedSystem::solutionPreviousNewton ( )
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 116 of file DisplacedSystem.h.

116 { return nullptr; }

◆ solutionPreviousNewton() [2/2]

const NumericVector<Number>* DisplacedSystem::solutionPreviousNewton ( ) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 117 of file DisplacedSystem.h.

117 { return nullptr; }

◆ solutionState() [1/2]

NumericVector< Number > & DisplacedSystem::solutionState ( const unsigned int  state,
Moose::SolutionIterationType  iteration_type = Moose::SolutionIterationType::Time 
)
inlineoverridevirtual

Get a state of the solution (0 = current, 1 = old, 2 = older, etc).

If the state does not exist, it will be initialized in addition to any newer states before it that have not been initialized.

Reimplemented from SystemBase.

Definition at line 268 of file DisplacedSystem.h.

270 {
271  return _undisplaced_system.solutionState(state, iteration_type);
272 }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419
SystemBase & _undisplaced_system

◆ solutionState() [2/2]

const NumericVector< Number > & DisplacedSystem::solutionState ( const unsigned int  state,
Moose::SolutionIterationType  iteration_type = Moose::SolutionIterationType::Time 
) const
inlineoverridevirtual

Get a state of the solution (0 = current, 1 = old, 2 = older, etc).

Reimplemented from SystemBase.

Definition at line 275 of file DisplacedSystem.h.

277 {
278  return _undisplaced_system.solutionState(state, iteration_type);
279 }
virtual NumericVector< Number > & solutionState(const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time)
Get a state of the solution (0 = current, 1 = old, 2 = older, etc).
Definition: SystemBase.C:1419
SystemBase & _undisplaced_system

◆ solutionStatesInitialized()

bool SystemBase::solutionStatesInitialized ( ) const
inlineinherited

Whether or not the solution states have been initialized via initSolutionState()

After the solution states have been initialized, additional solution states cannot be added.

Definition at line 897 of file SystemBase.h.

Referenced by ScalarKernelBase::uOld(), and AuxScalarKernel::uOld().

bool _solution_states_initialized
Whether or not the solution states have been initialized.
Definition: SystemBase.h:1053

◆ solutionUDot() [1/2]

NumericVector<Number>* DisplacedSystem::solutionUDot ( )
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 119 of file DisplacedSystem.h.

119 { return _undisplaced_system.solutionUDot(); }
SystemBase & _undisplaced_system
virtual NumericVector< Number > * solutionUDot()
Definition: SystemBase.h:252

◆ solutionUDot() [2/2]

const NumericVector<Number>* DisplacedSystem::solutionUDot ( ) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 132 of file DisplacedSystem.h.

133  {
135  }
SystemBase & _undisplaced_system
virtual NumericVector< Number > * solutionUDot()
Definition: SystemBase.h:252

◆ solutionUDotDot() [1/2]

NumericVector<Number>* DisplacedSystem::solutionUDotDot ( )
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 120 of file DisplacedSystem.h.

121  {
123  }
SystemBase & _undisplaced_system
virtual NumericVector< Number > * solutionUDotDot()
Definition: SystemBase.h:253

◆ solutionUDotDot() [2/2]

const NumericVector<Number>* DisplacedSystem::solutionUDotDot ( ) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 136 of file DisplacedSystem.h.

137  {
139  }
SystemBase & _undisplaced_system
virtual NumericVector< Number > * solutionUDotDot()
Definition: SystemBase.h:253

◆ solutionUDotDotOld() [1/2]

NumericVector<Number>* DisplacedSystem::solutionUDotDotOld ( )
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 128 of file DisplacedSystem.h.

129  {
131  }
virtual NumericVector< Number > * solutionUDotDotOld()
Definition: SystemBase.h:255
SystemBase & _undisplaced_system

◆ solutionUDotDotOld() [2/2]

const NumericVector<Number>* DisplacedSystem::solutionUDotDotOld ( ) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 144 of file DisplacedSystem.h.

145  {
147  }
virtual NumericVector< Number > * solutionUDotDotOld()
Definition: SystemBase.h:255
SystemBase & _undisplaced_system

◆ solutionUDotOld() [1/2]

NumericVector<Number>* DisplacedSystem::solutionUDotOld ( )
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 124 of file DisplacedSystem.h.

125  {
127  }
SystemBase & _undisplaced_system
virtual NumericVector< Number > * solutionUDotOld()
Definition: SystemBase.h:254

◆ solutionUDotOld() [2/2]

const NumericVector<Number>* DisplacedSystem::solutionUDotOld ( ) const
inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 140 of file DisplacedSystem.h.

141  {
143  }
SystemBase & _undisplaced_system
virtual NumericVector< Number > * solutionUDotOld()
Definition: SystemBase.h:254

◆ solve()

void SystemBase::solve ( )
virtualinherited

Solve the system (using libMesh magic)

Reimplemented in NonlinearSystemBase, LinearSystem, NonlinearEigenSystem, NonlinearSystem, DumpObjectsLinearSystem, and DumpObjectsNonlinearSystem.

Definition at line 1251 of file SystemBase.C.

1252 {
1253  system().solve();
1254 }
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
virtual void solve()

◆ subdomainSetup()

void SystemBase::subdomainSetup ( )
virtualinherited

Reimplemented in AuxiliarySystem.

Definition at line 1559 of file SystemBase.C.

Referenced by AuxiliarySystem::subdomainSetup(), and NonlinearSystemBase::subdomainSetup().

1560 {
1561  for (THREAD_ID tid = 0; tid < libMesh::n_threads(); tid++)
1562  _vars[tid].subdomainSetup();
1563 }
unsigned int n_threads()
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
virtual void subdomainSetup()
Definition: SystemBase.C:1559
unsigned int THREAD_ID
Definition: MooseTypes.h:209

◆ subproblem() [1/2]

SubProblem& SystemBase::subproblem ( )
inlineinherited

◆ subproblem() [2/2]

const SubProblem& SystemBase::subproblem ( ) const
inlineinherited

Definition at line 102 of file SystemBase.h.

102 { return _subproblem; }
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977

◆ sys()

virtual libMesh::System& DisplacedSystem::sys ( )
inlinevirtual

Definition at line 244 of file DisplacedSystem.h.

244 { return _sys; }
libMesh::System & _sys

◆ system() [1/2]

System & DisplacedSystem::system ( )
overridevirtual

Get the reference to the libMesh system.

Implements SystemBase.

Definition at line 56 of file DisplacedSystem.C.

57 {
58  return _sys;
59 }
libMesh::System & _sys

◆ system() [2/2]

const System & DisplacedSystem::system ( ) const
overridevirtual

Implements SystemBase.

Definition at line 62 of file DisplacedSystem.C.

63 {
64  return _sys;
65 }
libMesh::System & _sys

◆ systemMatrixTag()

virtual TagID DisplacedSystem::systemMatrixTag ( ) const
inlineoverridevirtual

Return the Matrix Tag ID for System.

Reimplemented from SystemBase.

Definition at line 48 of file DisplacedSystem.h.

SystemBase & _undisplaced_system
virtual TagID systemMatrixTag() const
Return the Matrix Tag ID for System.
Definition: SystemBase.h:288

◆ timestepSetup()

void SystemBase::timestepSetup ( )
virtualinherited

Reimplemented in NonlinearSystemBase, and AuxiliarySystem.

Definition at line 1545 of file SystemBase.C.

Referenced by AuxiliarySystem::timestepSetup(), and NonlinearSystemBase::timestepSetup().

1546 {
1547  for (THREAD_ID tid = 0; tid < libMesh::n_threads(); tid++)
1548  _vars[tid].timestepSetup();
1549 }
unsigned int n_threads()
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
Definition: SystemBase.h:990
unsigned int THREAD_ID
Definition: MooseTypes.h:209
virtual void timestepSetup()
Definition: SystemBase.C:1545

◆ timeVectorTag()

virtual TagID DisplacedSystem::timeVectorTag ( ) const
inlineoverridevirtual

Ideally, we should not need this API.

There exists a really bad API "addCachedResidualDirectly " in FEProblem and DisplacedProblem This API should go away once addCachedResidualDirectly is removed in the future Return Tag ID for Time

Reimplemented from SystemBase.

Definition at line 50 of file DisplacedSystem.h.

SystemBase & _undisplaced_system
virtual TagID timeVectorTag() const
Ideally, we should not need this API.
Definition: SystemBase.h:283

◆ update()

void SystemBase::update ( )
inherited

◆ varKind()

Moose::VarKindType SystemBase::varKind ( ) const
inlineinherited
Returns
the type of variables this system holds, e.g. nonlinear or auxiliary

Definition at line 925 of file SystemBase.h.

Referenced by Coupleable::coupled().

925 { return _var_kind; }
Moose::VarKindType _var_kind
default kind of variables in this system
Definition: SystemBase.h:1030

◆ zeroTaggedVector()

void SystemBase::zeroTaggedVector ( const TagID  tag)
inherited

Zero vector with the given tag.

Definition at line 666 of file SystemBase.C.

Referenced by SystemBase::zeroTaggedVectors().

667 {
668  if (!_subproblem.vectorTagExists(tag))
669  mooseError("Cannot zero vector with TagID ",
670  tag,
671  " in system '",
672  name(),
673  "' because that tag does not exist in the problem");
674  else if (!hasVector(tag))
675  mooseError("Cannot zero vector tag with name '",
677  "' in system '",
678  name(),
679  "' because there is no vector associated with that tag");
681  getVector(tag).zero();
682 }
bool hasVector(const std::string &tag_name) const
Check if the named vector exists in the system.
Definition: SystemBase.C:907
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
bool vectorTagNotZeroed(const TagID tag) const
Checks if a vector tag is in the list of vectors that will not be zeroed when other tagged vectors ar...
Definition: SubProblem.C:155
virtual void zero()=0
virtual const std::string & name() const
Definition: SystemBase.C:1330
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
Definition: SystemBase.h:977
virtual bool vectorTagExists(const TagID tag_id) const
Check to see if a particular Tag exists.
Definition: SubProblem.h:201
virtual TagName vectorTagName(const TagID tag) const
Retrieve the name associated with a TagID.
Definition: SubProblem.C:221
virtual NumericVector< Number > & getVector(const std::string &name)
Get a raw NumericVector by name.
Definition: SystemBase.C:916

◆ zeroTaggedVectors()

void SystemBase::zeroTaggedVectors ( const std::set< TagID > &  tags)
inherited

Zero all vectors for given tags.

Definition at line 685 of file SystemBase.C.

Referenced by NonlinearSystemBase::computeResidualAndJacobianTags(), and NonlinearSystemBase::computeResidualTags().

686 {
687  for (const auto tag : tags)
688  zeroTaggedVector(tag);
689 }
void zeroTaggedVector(const TagID tag)
Zero vector with the given tag.
Definition: SystemBase.C:666

◆ zeroVariables()

virtual void DisplacedSystem::zeroVariables ( std::vector< std::string > &  vars_to_be_zeroed)
inlineoverridevirtual

Zero out the solution for the list of variables passed in.

Reimplemented from SystemBase.

Definition at line 205 of file DisplacedSystem.h.

206  {
207  _undisplaced_system.zeroVariables(vars_to_be_zeroed);
208  }
SystemBase & _undisplaced_system
virtual void zeroVariables(std::vector< std::string > &vars_to_be_zeroed)
Zero out the solution for the list of variables passed in.
Definition: SystemBase.C:199

◆ zeroVariablesForJacobian()

void SystemBase::zeroVariablesForJacobian ( )
virtualinherited

Zero out the solution for the variables that were registered as needing to have their solutions zeroed on out on Jacobian evaluation by a call to addVariableToZeroOnResidual()

Definition at line 234 of file SystemBase.C.

235 {
237 }
std::vector< std::string > _vars_to_be_zeroed_on_jacobian
Definition: SystemBase.h:997
virtual void zeroVariables(std::vector< std::string > &vars_to_be_zeroed)
Zero out the solution for the list of variables passed in.
Definition: SystemBase.C:199

◆ zeroVariablesForResidual()

void SystemBase::zeroVariablesForResidual ( )
virtualinherited

Zero out the solution for the variables that were registered as needing to have their solutions zeroed on out on residual evaluation by a call to addVariableToZeroOnResidual()

Definition at line 228 of file SystemBase.C.

229 {
231 }
std::vector< std::string > _vars_to_be_zeroed_on_residual
Definition: SystemBase.h:996
virtual void zeroVariables(std::vector< std::string > &vars_to_be_zeroed)
Zero out the solution for the list of variables passed in.
Definition: SystemBase.C:199

Member Data Documentation

◆ _app

MooseApp& SystemBase::_app
protectedinherited

◆ _automatic_scaling

bool SystemBase::_automatic_scaling
protectedinherited

Whether to automatically scale the variables.

Definition at line 1047 of file SystemBase.h.

Referenced by SystemBase::automaticScaling(), NonlinearSystemBase::initialSetup(), and NonlinearSystemBase::preSolve().

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

Referenced by IterationAdaptiveDT::acceptStep(), MeshOnlyAction::act(), SetupDebugAction::act(), MaterialOutputAction::act(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), PerfGraph::addToExecutionList(), SimplePredictor::apply(), SystemBase::applyScalingFactors(), MultiApp::backup(), FEProblemBase::backupMultiApps(), CoarsenedPiecewiseLinear::buildCoarsenedGrid(), MeshDiagnosticsGenerator::checkElementOverlap(), MeshDiagnosticsGenerator::checkElementTypes(), MeshDiagnosticsGenerator::checkElementVolumes(), FEProblemBase::checkExceptionAndStopSolve(), SolverSystem::checkInvalidSolution(), MeshDiagnosticsGenerator::checkLocalJacobians(), MeshDiagnosticsGenerator::checkNonConformalMesh(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkNonPlanarSides(), FEProblemBase::checkProblemIntegrity(), ReferenceResidualConvergence::checkRelativeConvergence(), MeshDiagnosticsGenerator::checkSidesetsOrientation(), MeshDiagnosticsGenerator::checkWatertightNodesets(), MeshDiagnosticsGenerator::checkWatertightSidesets(), IterationAdaptiveDT::computeAdaptiveDT(), TransientBase::computeConstrainedDT(), DefaultMultiAppFixedPointConvergence::computeCustomConvergencePostprocessor(), NonlinearSystemBase::computeDamping(), FixedPointIterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInitialDT(), IterationAdaptiveDT::computeInterpolationDT(), LinearSystem::computeLinearSystemTags(), FEProblemBase::computeLinearSystemTags(), NonlinearSystemBase::computeScaling(), Problem::console(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), MultiApp::createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MFEMSteady::execute(), MessageFromInput::execute(), SteadyBase::execute(), Eigenvalue::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), MeshGeneratorSystem::executeMeshGenerators(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), MeshRepairGenerator::fixOverlappingNodes(), CoarsenBlockGenerator::generate(), MeshGenerator::generateInternal(), VariableCondensationPreconditioner::getDofToCondense(), InversePowerMethod::init(), NonlinearEigen::init(), FEProblemBase::initialAdaptMesh(), DefaultMultiAppFixedPointConvergence::initialize(), EigenExecutionerBase::inversePowerIteration(), FEProblemBase::joinAndFinalize(), TransientBase::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), FEProblemBase::logAdd(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), MooseBaseErrorInterface::mooseDeprecated(), MooseBaseErrorInterface::mooseInfo(), MooseBaseErrorInterface::mooseWarning(), MooseBaseErrorInterface::mooseWarningNonPrefixed(), ReferenceResidualConvergence::nonlinearConvergenceSetup(), ReporterDebugOutput::output(), PerfGraphOutput::output(), SolutionInvalidityOutput::output(), MaterialPropertyDebugOutput::output(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), Console::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), Console::outputPostprocessors(), PseudoTimestep::outputPseudoTimestep(), Console::outputReporters(), DefaultMultiAppFixedPointConvergence::outputResidualNorm(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), SolutionInvalidity::printDebug(), EigenExecutionerBase::printEigenvalue(), SecantSolve::printFixedPointConvergenceHistory(), SteffensenSolve::printFixedPointConvergenceHistory(), PicardSolve::printFixedPointConvergenceHistory(), FixedPointSolve::printFixedPointConvergenceReason(), PerfGraphLivePrint::printLiveMessage(), MaterialPropertyDebugOutput::printMaterialMap(), PerfGraphLivePrint::printStats(), NEML2Action::printSummary(), AutomaticMortarGeneration::projectPrimaryNodesSinglePair(), AutomaticMortarGeneration::projectSecondaryNodesSinglePair(), CoarsenBlockGenerator::recursiveCoarsen(), SolutionTimeAdaptiveDT::rejectStep(), MultiApp::restore(), FEProblemBase::restoreMultiApps(), FEProblemBase::restoreSolutions(), NonlinearSystemBase::setInitialSolution(), MooseApp::setupOptions(), Checkpoint::shouldOutput(), SubProblem::showFunctorRequestors(), SubProblem::showFunctors(), FullSolveMultiApp::showStatusMessage(), FEProblemSolve::solve(), FixedPointSolve::solve(), EigenProblem::solve(), NonlinearSystem::solve(), LinearSystem::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), FixedPointSolve::solveStep(), PerfGraphLivePrint::start(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), TransientBase::takeStep(), TerminateChainControl::terminate(), Convergence::verboseOutput(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

◆ _du_dot_du

std::vector<Real> SystemBase::_du_dot_du
protectedinherited

Derivative of time derivative of u with respect to uj.

This depends on the time integration scheme

Definition at line 1011 of file SystemBase.h.

Referenced by SystemBase::addVariable(), SystemBase::duDotDu(), and SystemBase::duDotDus().

◆ _du_dotdot_du

Real SystemBase::_du_dotdot_du
protectedinherited

Definition at line 1012 of file SystemBase.h.

Referenced by SystemBase::duDotDotDu().

◆ _factory

Factory& SystemBase::_factory
protectedinherited

◆ _fe_problem

FEProblemBase& SystemBase::_fe_problem
protectedinherited

the governing finite element/volume problem

Definition at line 980 of file SystemBase.h.

Referenced by NonlinearSystemBase::addBoundaryCondition(), NonlinearSystemBase::addDGKernel(), NonlinearSystemBase::addDiracKernel(), SystemBase::addDotVectors(), NonlinearSystemBase::addHDGKernel(), NonlinearSystemBase::addInterfaceKernel(), NonlinearSystemBase::addKernel(), NonlinearSystemBase::addNodalKernel(), NonlinearSystemBase::addScalarKernel(), NonlinearSystemBase::addSplit(), NonlinearSystemBase::assembleScalingVector(), NonlinearSystemBase::augmentSparsity(), AuxiliarySystem::AuxiliarySystem(), SolverSystem::checkInvalidSolution(), NonlinearSystemBase::checkKernelCoverage(), AuxiliarySystem::clearScalarVariableCoupleableTags(), SolverSystem::compute(), AuxiliarySystem::compute(), NonlinearSystemBase::computeDamping(), NonlinearSystemBase::computeDiracContributions(), AuxiliarySystem::computeElementalVarsHelper(), LinearSystem::computeGradients(), NonlinearSystemBase::computeJacobian(), NonlinearSystemBase::computeJacobianBlocks(), NonlinearSystemBase::computeJacobianInternal(), LinearSystem::computeLinearSystemInternal(), LinearSystem::computeLinearSystemTags(), AuxiliarySystem::computeMortarNodalVars(), NonlinearSystemBase::computeNodalBCs(), NonlinearSystemBase::computeNodalBCsResidualAndJacobian(), AuxiliarySystem::computeNodalVarsHelper(), NonlinearSystemBase::computeResidualAndJacobianInternal(), NonlinearSystemBase::computeResidualInternal(), NonlinearSystemBase::computeResidualTags(), NonlinearSystemBase::computeScalarKernelsJacobians(), AuxiliarySystem::computeScalarVars(), NonlinearSystemBase::computeScaling(), NonlinearSystem::computeScalingJacobian(), NonlinearSystem::computeScalingResidual(), NonlinearSystemBase::constraintJacobians(), NonlinearSystemBase::constraintResiduals(), LinearSystem::containsTimeKernel(), NonlinearSystem::converged(), NonlinearSystemBase::customSetup(), MooseEigenSystem::eigenKernelOnCurrent(), MooseEigenSystem::eigenKernelOnOld(), NonlinearSystemBase::enforceNodalConstraintsJacobian(), NonlinearSystemBase::enforceNodalConstraintsResidual(), SystemBase::feProblem(), NonlinearSystemBase::getResidualNonTimeVector(), NonlinearSystemBase::getResidualTimeVector(), NonlinearSystemBase::initialSetup(), NonlinearSystemBase::jacobianSetup(), LinearSystem::LinearSystem(), NonlinearSystemBase::NonlinearSystemBase(), NonlinearSystemBase::overwriteNodeFace(), NonlinearSystem::potentiallySetupFiniteDifferencing(), NonlinearSystemBase::preInit(), NonlinearSystemBase::reinitNodeFace(), NonlinearSystem::residualAndJacobianTogether(), NonlinearSystemBase::residualSetup(), NonlinearSystemBase::setConstraintSecondaryValues(), NonlinearSystemBase::setInitialSolution(), AuxiliarySystem::setScalarVariableCoupleableTags(), NonlinearSystemBase::shouldEvaluatePreSMOResidual(), NonlinearSystem::solve(), and NonlinearSystemBase::timestepSetup().

◆ _matrix_tag_active_flags

std::vector<bool> SystemBase::_matrix_tag_active_flags
protectedinherited

◆ _max_var_n_dofs_per_elem

size_t SystemBase::_max_var_n_dofs_per_elem
protectedinherited

Maximum number of dofs for any one variable on any one element.

Definition at line 1035 of file SystemBase.h.

Referenced by SystemBase::assignMaxVarNDofsPerElem(), and SystemBase::getMaxVarNDofsPerElem().

◆ _max_var_n_dofs_per_node

size_t SystemBase::_max_var_n_dofs_per_node
protectedinherited

Maximum number of dofs for any one variable on any one node.

Definition at line 1038 of file SystemBase.h.

Referenced by SystemBase::assignMaxVarNDofsPerNode(), and SystemBase::getMaxVarNDofsPerNode().

◆ _max_var_number

unsigned int SystemBase::_max_var_number
protectedinherited

Maximum variable number.

Definition at line 994 of file SystemBase.h.

Referenced by SystemBase::addVariable(), and SystemBase::getMaxVariableNumber().

◆ _mesh

MooseMesh& SystemBase::_mesh
protectedinherited

◆ _name

std::string SystemBase::_name
protectedinherited

The name of this system.

Definition at line 987 of file SystemBase.h.

◆ _numbered_vars

std::vector<std::vector<MooseVariableFieldBase *> > SystemBase::_numbered_vars
protectedinherited

Map variable number to its pointer.

Definition at line 1044 of file SystemBase.h.

Referenced by SystemBase::addVariable(), and SystemBase::getVariable().

◆ _raw_grad_container

std::vector<std::unique_ptr<NumericVector<Number> > > SystemBase::_raw_grad_container
protectedinherited

A cache for storing gradients at dof locations.

We store it on the system because we create copies of variables on each thread and that would lead to increased data duplication when using threading-based parallelism.

Definition at line 1065 of file SystemBase.h.

Referenced by LinearSystem::computeGradients(), SystemBase::gradientContainer(), and SystemBase::initialSetup().

◆ _saved_dot_old

NumericVector<Real>* SystemBase::_saved_dot_old
protectedinherited

Definition at line 1026 of file SystemBase.h.

Referenced by SystemBase::restoreOldSolutions(), and SystemBase::saveOldSolutions().

◆ _saved_dotdot_old

NumericVector<Real>* SystemBase::_saved_dotdot_old
protectedinherited

Definition at line 1027 of file SystemBase.h.

Referenced by SystemBase::restoreOldSolutions(), and SystemBase::saveOldSolutions().

◆ _saved_old

NumericVector<Real>* SystemBase::_saved_old
protectedinherited

Definition at line 1022 of file SystemBase.h.

◆ _saved_older

NumericVector<Real>* SystemBase::_saved_older
protectedinherited

Definition at line 1023 of file SystemBase.h.

◆ _serialized_solution

std::unique_ptr<NumericVector<Number> > SystemBase::_serialized_solution
protectedinherited

Serialized version of the solution vector, or nullptr if a serialized solution is not needed.

Definition at line 1060 of file SystemBase.h.

Referenced by AuxiliarySystem::compute(), SolverSystem::preInit(), SystemBase::serializedSolution(), SolverSystem::serializeSolution(), AuxiliarySystem::serializeSolution(), and SolverSystem::setSolution().

◆ _solution_states_initialized

bool SystemBase::_solution_states_initialized
protectedinherited

Whether or not the solution states have been initialized.

Definition at line 1053 of file SystemBase.h.

Referenced by SystemBase::initSolutionState(), and SystemBase::solutionStatesInitialized().

◆ _subproblem

SubProblem& SystemBase::_subproblem
protectedinherited

◆ _sys

libMesh::System& DisplacedSystem::_sys
protected

Definition at line 258 of file DisplacedSystem.h.

Referenced by DisplacedSystem(), getVector(), sys(), and system().

◆ _tagged_matrices

std::vector<libMesh::SparseMatrix<Number> *> SystemBase::_tagged_matrices
protectedinherited

◆ _tagged_vectors

std::vector<NumericVector<Number> *> SystemBase::_tagged_vectors
protectedinherited

◆ _time_integrators

std::vector<std::shared_ptr<TimeIntegrator> > SystemBase::_time_integrators
protectedinherited

◆ _u_dot

NumericVector<Number>* SystemBase::_u_dot
protectedinherited

solution vector for u^dot

Definition at line 1000 of file SystemBase.h.

Referenced by SystemBase::addDotVectors(), NonlinearSystemBase::setSolutionUDot(), and SystemBase::solutionUDot().

◆ _u_dot_old

NumericVector<Number>* SystemBase::_u_dot_old
protectedinherited

old solution vector for u^dot

Definition at line 1005 of file SystemBase.h.

Referenced by SystemBase::addDotVectors(), NonlinearSystemBase::setSolutionUDotOld(), and SystemBase::solutionUDotOld().

◆ _u_dotdot

NumericVector<Number>* SystemBase::_u_dotdot
protectedinherited

solution vector for u^dotdot

Definition at line 1002 of file SystemBase.h.

Referenced by SystemBase::addDotVectors(), NonlinearSystemBase::setSolutionUDotDot(), and SystemBase::solutionUDotDot().

◆ _u_dotdot_old

NumericVector<Number>* SystemBase::_u_dotdot_old
protectedinherited

old solution vector for u^dotdot

Definition at line 1007 of file SystemBase.h.

Referenced by SystemBase::addDotVectors(), NonlinearSystemBase::setSolutionUDotDotOld(), and SystemBase::solutionUDotDotOld().

◆ _undisplaced_system

SystemBase& DisplacedSystem::_undisplaced_system
protected

◆ _var_all_dof_indices

std::vector<dof_id_type> SystemBase::_var_all_dof_indices
protectedinherited

Container for the dof indices of a given variable.

Definition at line 1056 of file SystemBase.h.

Referenced by SystemBase::getVariableGlobalDoFs(), and SystemBase::setVariableGlobalDoFs().

◆ _var_kind

Moose::VarKindType SystemBase::_var_kind
protectedinherited

default kind of variables in this system

Definition at line 1030 of file SystemBase.h.

Referenced by SystemBase::varKind().

◆ _var_map

std::map<unsigned int, std::set<SubdomainID> > SystemBase::_var_map
protectedinherited

Map of variables (variable id -> array of subdomains where it lives)

Definition at line 992 of file SystemBase.h.

Referenced by SystemBase::addVariable(), SystemBase::getSubdomainsForVar(), and SystemBase::getVariableBlocks().

◆ _var_to_copy

std::vector<VarCopyInfo> SystemBase::_var_to_copy
protectedinherited

◆ _vars

std::vector<VariableWarehouse> SystemBase::_vars
protectedinherited

Variable warehouses (one for each thread)

Definition at line 990 of file SystemBase.h.

Referenced by NonlinearSystemBase::addBoundaryCondition(), NonlinearSystemBase::addInterfaceKernel(), AuxiliarySystem::addVariable(), SystemBase::addVariable(), SystemBase::applyScalingFactors(), NonlinearSystemBase::assembleScalingVector(), SystemBase::clearAllDofIndices(), AuxiliarySystem::compute(), SystemBase::customSetup(), SystemBase::getActualFieldVariable(), SystemBase::getFieldVariable(), SystemBase::getFVVariable(), AuxiliarySystem::getMinQuadratureOrder(), SystemBase::getMinQuadratureOrder(), SystemBase::getScalarVariable(), SystemBase::getScalarVariables(), SystemBase::getVariable(), SystemBase::getVariableNames(), SystemBase::getVariables(), LinearSystem::initialSetup(), SystemBase::initialSetup(), SystemBase::jacobianSetup(), SystemBase::nFieldVariables(), SystemBase::nFVVariables(), SystemBase::nVariables(), SystemBase::prepare(), SystemBase::prepareFace(), SystemBase::prepareLowerD(), SystemBase::prepareNeighbor(), SystemBase::reinitElem(), SystemBase::reinitElemFace(), SystemBase::reinitLowerD(), SystemBase::reinitNeighbor(), SystemBase::reinitNeighborFace(), SystemBase::reinitNode(), SystemBase::reinitNodeFace(), SystemBase::reinitNodes(), SystemBase::reinitNodesNeighbor(), SystemBase::reinitScalars(), SystemBase::residualSetup(), SystemBase::setActiveScalarVariableCoupleableVectorTags(), SystemBase::setActiveVariableCoupleableVectorTags(), NonlinearSystemBase::setupScalingData(), SystemBase::subdomainSetup(), and SystemBase::timestepSetup().

◆ _vars_to_be_zeroed_on_jacobian

std::vector<std::string> SystemBase::_vars_to_be_zeroed_on_jacobian
protectedinherited

◆ _vars_to_be_zeroed_on_residual

std::vector<std::string> SystemBase::_vars_to_be_zeroed_on_residual
protectedinherited

◆ _verbose

bool SystemBase::_verbose
protectedinherited

True if printing out additional information.

Definition at line 1050 of file SystemBase.h.

Referenced by SystemBase::applyScalingFactors(), and SystemBase::setVerboseFlag().


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