#include <DisplacedSystem.h>

Inheritance diagram for DisplacedSystem:

Public Member Functions
	DisplacedSystem (DisplacedSystem &&)=delete

DisplacedSystem &	operator= (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.

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.

virtual TagID	timeVectorTag () const override
	Ideally, we should not need this API.

virtual TagID	nonTimeVectorTag () const override

virtual std::set< TagID >	defaultVectorTags () const override
	Get the default vector tags associated with this system.

virtual std::set< TagID >	defaultMatrixTags () const override
	Get the default matrix tags associted with this system.

virtual void	associateVectorToTag (NumericVector< Number > &vec, TagID tag) override
	Associate a vector for a given tag.

virtual void	disassociateVectorFromTag (NumericVector< Number > &vec, TagID tag) override
	Disassociate a given vector from a given tag.

virtual void	disassociateVectorFromTag (TagID tag) override
	Disassociate any vector that is associated with a given tag.

virtual void	disassociateDefaultVectorTags () override
	Disassociate the vectors associated with the default vector tags of this system.

virtual void	associateMatrixToTag (libMesh::SparseMatrix< Number > &matrix, TagID tag) override
	Associate a matrix to a tag.

virtual void	disassociateMatrixFromTag (libMesh::SparseMatrix< Number > &matrix, TagID tag) override
	Disassociate a matrix from a tag.

virtual void	disassociateMatrixFromTag (TagID tag) override
	Disassociate any matrix that is associated with a given tag.

virtual void	disassociateDefaultMatrixTags () override
	Disassociate the matrices associated with the default matrix tags of this system.

virtual NumericVector< Number > &	getVector (const std::string &name) override
	Get a raw NumericVector by name.

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.

const NumericVector< Number > *const &	currentSolution () const override
	The solution vector that is currently being operated on.

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 Number &	duDotDotDu () override

virtual const Number &	duDotDu (unsigned int var_num=0) const override

virtual const Number &	duDotDotDu () 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.

virtual NumericVector< Number > &	residualCopy () override
	Return the residual copy from the NonlinearSystem.

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.

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.

virtual void	addVariableToZeroOnResidual (std::string var_name) override
	Adds this variable to the list of variables to be zeroed during each residual evaluation.

virtual void	addVariableToZeroOnJacobian (std::string var_name) override
	Adds this variable to the list of variables to be zeroed during each jacobian evaluation.

virtual void	zeroVariables (std::vector< std::string > &vars_to_be_zeroed) override
	Zero out the solution for the list of variables passed in.

virtual bool	hasVector (TagID tag_id) const override
	Check if the tagged vector exists in the system.

virtual bool	hasMatrix (TagID tag_id) const override
	Check if the tagged matrix exists in the system.

virtual void	initSolutionState () override
	Initializes the solution state.

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

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

virtual void	needSolutionState (const unsigned int state, Moose::SolutionIterationType iteration_type=Moose::SolutionIterationType::Time, libMesh::ParallelType parallel_type=GHOSTED) override
	Registers that the solution state `state` is needed.

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

virtual libMesh::SparseMatrix< Number > &	getMatrix (TagID tag) override
	Get a raw SparseMatrix.

virtual const libMesh::SparseMatrix< Number > &	getMatrix (TagID tag) const override
	Get a raw SparseMatrix.

virtual libMesh::System &	sys ()

virtual System &	system () override
	Get the reference to the libMesh system.

virtual const System &	system () const override

virtual void	compute (ExecFlagType) override
	Compute time derivatives, auxiliary variables, etc.

unsigned int	number () const
	Gets the number of this system.

MooseMesh &	mesh ()

const MooseMesh &	mesh () const

SubProblem &	subproblem ()

const SubProblem &	subproblem () const

FEProblemBase &	feProblem ()

const FEProblemBase &	feProblem () const

THREAD_ID	numThreads () const

void	applyScalingFactors (const std::vector< Real > &inverse_scaling_factors)
	Applies scaling factors to the system's variables.

bool	computingScalingJacobian () const
	Whether we are computing an initial Jacobian for automatic variable scaling.

bool	automaticScaling () const
	Getter for whether we are performing automatic scaling.

void	automaticScaling (bool automatic_scaling)
	Setter for whether we are performing automatic scaling.

void	setVerboseFlag (const bool &verbose)
	Sets the verbose flag.

virtual libMesh::DofMap &	dofMap ()
	Gets writeable reference to the dof map.

virtual const libMesh::DofMap &	dofMap () const
	Gets const reference to the dof map.

virtual void	preInit ()
	This is called prior to the libMesh system has been init'd.

virtual void	postInit ()

virtual void	reinit ()
	Reinitialize the system when the degrees of freedom in this system have changed.

virtual void	initializeObjects ()
	Called only once, just before the solve begins so objects can do some precalculations.

void	update ()
	Update the system (doing libMesh magic)

virtual void	solve ()
	Solve the system (using libMesh magic)

void	copyOldSolutions ()
	Copy the solution back in time (older -> old, etc).

void	advanceStateHistory (Moose::SolutionIterationType iteration_type)
	Advance solution vectors and additional system-owned state together.

void	copyPreviousSolutions (const Moose::SolutionIterationType iteration_type)
	Copy a specific type of solution back in time (current -> old -> older, etc).

void	restoreStateHistory ()
	Restore solution vectors and additional system-owned state together.

virtual void	restoreSolutions ()
	Restore current solutions (call after your solve failed)

NumericVector< Number > &	solution ()

const NumericVector< Number > &	solution () const

NumericVector< Number > &	solutionOld ()

const NumericVector< Number > &	solutionOld () const

NumericVector< Number > &	solutionOlder ()

const NumericVector< Number > &	solutionOlder () const

const std::vector< NumericVector< Number > * > &	getSolutionStates (const Moose::SolutionIterationType iteration_type) const
	Get all of the solution states (current, old, ...) for the given iteration type.

std::size_t	getNumSolutionStates (const Moose::SolutionIterationType iteration_type) const
	Get the number of solution states (0 = current, 1 = current + old, ...) for the given iteration type.

libMesh::ParallelType	solutionStateParallelType (const unsigned int state, const Moose::SolutionIterationType iteration_type) const
	Returns the parallel type of the given solution state.

virtual void	saveOldSolutions ()
	Save the old and older solutions.

virtual void	restoreOldSolutions ()
	Restore the old and older solutions when the saved solutions present.

bool	hasVector (const std::string &tag_name) const
	Check if the named vector exists in the system.

virtual void	activateAllMatrixTags ()
	Make all existing matrices active.

virtual bool	matrixTagActive (TagID tag) const
	If or not a matrix tag is active.

virtual void	deactivateAllMatrixTags ()
	Make matrices inactive.

void	closeTaggedMatrices (const std::set< TagID > &tags)
	Close all matrices associated the tags.

void	flushTaggedMatrices (const std::set< TagID > &tags)
	flushes all matrices associated to tags.

virtual void	addVariable (const std::string &var_type, const std::string &var_name, InputParameters &parameters)
	Canonical method for adding a variable.

virtual bool	isArrayVariable (const std::string &var_name) const
	If a variable is an array variable.

virtual bool	isScalarVariable (unsigned int var_name) const

MooseVariableFieldBase &	getVariable (THREAD_ID tid, const std::string &var_name) const
	Gets a reference to a variable of with specified name.

MooseVariableFieldBase &	getVariable (THREAD_ID tid, unsigned int var_number) const
	Gets a reference to a variable with specified number.

template<typename T >
MooseVariableFE< T > &	getFieldVariable (THREAD_ID tid, const std::string &var_name)
	Gets a reference to a variable of with specified name.

template<typename T >
MooseVariableFE< T > &	getFieldVariable (THREAD_ID tid, unsigned int var_number)
	Gets a reference to a variable with specified number.

template<typename T >
MooseVariableField< T > &	getActualFieldVariable (THREAD_ID tid, const std::string &var_name)
	Returns a field variable pointer - this includes finite volume variables.

template<typename T >
MooseVariableField< T > &	getActualFieldVariable (THREAD_ID tid, unsigned int var_number)
	Returns a field variable pointer - this includes finite volume variables.

template<typename T >
MooseVariableFV< T > &	getFVVariable (THREAD_ID tid, const std::string &var_name)
	Return a finite volume variable.

virtual MooseVariableScalar &	getScalarVariable (THREAD_ID tid, const std::string &var_name) const
	Gets a reference to a scalar variable with specified number.

virtual MooseVariableScalar &	getScalarVariable (THREAD_ID tid, unsigned int var_number) const
	Gets a reference to a variable with specified number.

virtual const std::set< SubdomainID > *	getVariableBlocks (unsigned int var_number)
	Get the block where a variable of this system is defined.

virtual unsigned int	nVariables () const
	Get the number of variables in this system.

unsigned int	nFieldVariables () const
	Get the number of field variables in this system.

unsigned int	nFVVariables () const
	Get the number of finite volume variables in this system.

std::size_t	getMaxVarNDofsPerElem () const
	Gets the maximum number of dofs used by any one variable on any one element.

std::size_t	getMaxVarNDofsPerNode () const
	Gets the maximum number of dofs used by any one variable on any one node.

void	assignMaxVarNDofsPerElem (std::size_t max_dofs)
	assign the maximum element dofs

void	assignMaxVarNDofsPerNode (std::size_t max_dofs)
	assign the maximum node dofs

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

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

virtual libMesh::Order	getMinQuadratureOrder ()
	Get minimal quadrature order needed for integrating variables in this system.

virtual void	prepare (THREAD_ID tid)
	Prepare the system for use.

virtual void	prepareFace (THREAD_ID tid, bool resize_data)
	Prepare the system for use on sides.

virtual void	prepareNeighbor (THREAD_ID tid)
	Prepare the system for use.

virtual void	prepareLowerD (THREAD_ID tid)
	Prepare the system for use for lower dimensional elements.

virtual void	reinitElem (const Elem *elem, THREAD_ID tid)
	Reinit an element assembly info.

virtual void	reinitElemFace (const Elem *elem, unsigned int side, THREAD_ID tid)
	Reinit assembly info for a side of an element.

virtual void	reinitNeighborFace (const Elem *elem, unsigned int side, THREAD_ID tid)
	Compute the values of the variables at all the current points.

virtual void	reinitNeighbor (const Elem *elem, THREAD_ID tid)
	Compute the values of the variables at all the current points.

virtual void	reinitLowerD (THREAD_ID tid)
	Compute the values of the variables on the lower dimensional element.

virtual void	reinitNode (const Node *node, THREAD_ID tid)
	Reinit nodal assembly info.

virtual void	reinitNodeFace (const Node *node, BoundaryID bnd_id, THREAD_ID tid)
	Reinit nodal assembly info on a face.

virtual void	reinitNodes (const std::vector< dof_id_type > &nodes, THREAD_ID tid)
	Reinit variables at a set of nodes.

virtual void	reinitNodesNeighbor (const std::vector< dof_id_type > &nodes, THREAD_ID tid)
	Reinit variables at a set of neighbor nodes.

virtual void	reinitScalars (THREAD_ID tid, bool reinit_for_derivative_reordering=false)
	Reinit scalar varaibles.

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.

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

const VariableWarehouse &	variableWarehouse (THREAD_ID tid=0) const

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.

void	removeVector (const std::string &name)
	Remove a vector from the system with the given name.

void	removeVector (TagID tag_id)
	Remove a solution length vector from the system with the specified TagID.

NumericVector< Number > &	addVector (const std::string &vector_name, const bool project, const libMesh::ParallelType type)
	Adds a solution length vector to the system.

NumericVector< Number > &	addVector (TagID tag, const bool project, const libMesh::ParallelType type)
	Adds a solution length vector to the system with the specified TagID.

void	closeTaggedVector (const TagID tag)
	Close vector with the given tag.

void	closeTaggedVectors (const std::set< TagID > &tags)
	Close all vectors for given tags.

void	zeroTaggedVector (const TagID tag)
	Zero vector with the given tag.

void	zeroTaggedVectors (const std::set< TagID > &tags)
	Zero all vectors for given tags.

void	setVariableGlobalDoFs (const std::string &var_name)
	set all the global dof indices for a variable

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`

libMesh::SparseMatrix< Number > &	addMatrix (TagID tag)
	Adds a matrix with a given tag.

void	removeMatrix (TagID tag)
	Removes a matrix with a given tag.

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.

virtual void	computeVariables (const NumericVector< Number > &)

void	copyVars (libMesh::ExodusII_IO &io)

virtual void	copySolutionsBackwards ()
	Copy current solution into old and older.

void	copyStateHistoryBackwards ()
	Copy solution vectors and additional system-owned state into older states.

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.

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

virtual void	initialSetup ()
	Setup Functions.

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.

void	setActiveVariableCoupleableVectorTags (const std::set< TagID > &vtags, THREAD_ID tid)
	Set the active vector tags for the variables.

void	setActiveScalarVariableCoupleableVectorTags (const std::set< TagID > &vtags, THREAD_ID tid)
	Set the active vector tags for the scalar variables.

Moose::VarKindType	varKind () const

void	copyTimeIntegrators (const SystemBase &other_sys)
	Copy time integrators from another system.

const TimeIntegrator &	getTimeIntegrator (const unsigned int var_num) const
	Retrieve the time integrator that integrates the given variable's equation.

const TimeIntegrator *	queryTimeIntegrator (const unsigned int var_num) const
	Retrieve the time integrator that integrates the given variable's equation.

const std::vector< std::shared_ptr< TimeIntegrator > > &	getTimeIntegrators ()

std::string	prefix () const

void	sizeVariableMatrixData ()
	size the matrix data for each variable for the number of matrix tags we have

void	skipNextSolutionToOldCopy ()
	Skip the next copy from the solution vector to the old solution vector old -> older is still performed.

const Parallel::Communicator &	comm () 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.

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.

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

virtual void	copyAdditionalStateBackwards (Moose::SolutionIterationType, bool)
	Copy system-owned state not represented by solution vectors.

virtual void	restoreAdditionalStates ()
	Restore system-owned state not represented by solution vectors.

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.

FEProblemBase &	_fe_problem
	the governing finite element/volume problem

MooseApp &	_app

Factory &	_factory

MooseMesh &	_mesh

std::string	_name
	The name of this system.

std::vector< VariableWarehouse >	_vars
	Variable warehouses (one for each thread)

std::map< unsigned int, std::set< SubdomainID > >	_var_map
	Map of variables (variable id -> array of subdomains where it lives)

unsigned int	_max_var_number
	Maximum variable number.

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

NumericVector< Number > *	_u_dotdot
	solution vector for u^dotdot

NumericVector< Number > *	_u_dot_old
	old solution vector for u^dot

NumericVector< Number > *	_u_dotdot_old
	old solution vector for u^dotdot

std::vector< Real >	_du_dot_du
	Derivative of time derivative of u with respect to uj.

Real	_du_dotdot_du

std::vector< NumericVector< Number > * >	_tagged_vectors
	Tagged vectors (pointer)

std::vector< libMesh::SparseMatrix< Number > * >	_tagged_matrices
	Tagged matrices (pointer)

std::unordered_map< TagID, libMesh::SparseMatrix< Number > * >	_active_tagged_matrices
	Active tagged matrices. A matrix is active if its tag-matrix pair is present in the map. We use a map instead of a vector so that users can easily add and remove to this container with calls to (de)activateMatrixTag.

std::vector< bool >	_matrix_tag_active_flags
	Active flags for tagged matrices.

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

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.

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

std::vector< std::shared_ptr< TimeIntegrator > >	_time_integrators
	Time integrator.

std::vector< std::vector< MooseVariableFieldBase * > >	_numbered_vars
	Map variable number to its pointer.

bool	_automatic_scaling
	Whether to automatically scale the variables.

bool	_verbose
	True if printing out additional information.

bool	_solution_states_initialized
	Whether or not the solution states have been initialized.

std::vector< dof_id_type >	_var_all_dof_indices
	Container for the dof indices of a given variable.

std::unique_ptr< NumericVector< Number > >	_serialized_solution
	Serialized version of the solution vector, or nullptr if a serialized solution is not needed.

const Parallel::Communicator &	_communicator

Private Member Functions
std::vector< NumericVector< Number > * > &	getSolutionStates (const Moose::SolutionIterationType iteration_type)
	Get all of the solution states (current, old, ...) for the given iteration type.

TagName	oldSolutionStateVectorName (const unsigned int, Moose::SolutionIterationType iteration_type) const
	Gets the vector name used for an old (not current) solution state.

Private Attributes
std::array< std::vector< NumericVector< Number > * >, static_cast< size_t >(Moose::SolutionIterationType::Count)>	_solution_states
	2D array of solution state vector pointers.

std::vector< NumericVector< Number > * >	_saved_solution_states
	The saved solution states (0 = current, 1 = old, 2 = older, etc)

bool	_skip_next_solution_to_old_copy
	Whether to skip the next copy from the solution to the old vector.

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.

  : SystemBase(problem, fe_problem, name, var_kind),
    _undisplaced_system(undisplaced_system),
    _sys(problem.es().add_system<libMesh::System>(name))
{
  if (!problem.defaultGhosting())
  {
    auto & dof_map = _sys.get_dof_map();
    dof_map.remove_algebraic_ghosting_functor(dof_map.default_algebraic_ghosting());
    dof_map.set_implicit_neighbor_dofs(false);
  }
}

◆ ~DisplacedSystem()

DisplacedSystem::~DisplacedSystem ( )

virtual

Definition at line 35 of file DisplacedSystem.C.

35{}

Member Function Documentation

◆ activateAllMatrixTags()

void SystemBase::activateAllMatrixTags ( )

virtualinherited

Make all existing matrices active.

Definition at line 1131 of file SystemBase.C.

{
  auto num_matrix_tags = _subproblem.numMatrixTags();
 
  _matrix_tag_active_flags.resize(num_matrix_tags);
  _active_tagged_matrices.clear();
 
  for (const auto tag : make_range(num_matrix_tags))
    if (hasMatrix(tag))
    {
      _matrix_tag_active_flags[tag] = true;
      _active_tagged_matrices.emplace(tag, &getMatrix(tag));
    }
    else
      _matrix_tag_active_flags[tag] = false;
}

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

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

154{ _undisplaced_system.addDotVectors(); }

SystemBase::addDotVectors

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:1650

◆ addMatrix()

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

inherited

Adds a matrix with a given tag.

Parameters

tag_name The name of the tag

Definition at line 570 of file SystemBase.C.

{
  if (!_subproblem.matrixTagExists(tag))
    mooseError("Cannot add tagged matrix with TagID ",
               tag,
               " in system '",
               name(),
               "' because the tag does not exist in the problem");
 
  if (hasMatrix(tag))
    return getMatrix(tag);
 
  const auto matrix_name = _subproblem.matrixTagName(tag);
  SparseMatrix<Number> & mat = system().add_matrix(matrix_name);
  associateMatrixToTag(mat, tag);
 
  return mat;
}

◆ addTimeIntegrator()

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

inherited

Definition at line 1675 of file SystemBase.C.

{
  parameters.set<SystemBase *>("_sys") = this;
  _time_integrators.push_back(_factory.create<TimeIntegrator>(type, name, parameters));
}

◆ 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_type	the type of the variable, e.g. MooseVariableScalar
var_name	the variable name, e.g. 'u'
params	the InputParameters from which to construct the variable

Reimplemented in AuxiliarySystem.

Definition at line 720 of file SystemBase.C.

{
  _numbered_vars.resize(numThreads());
 
  const auto components = parameters.get<unsigned int>("components");
 
  // Convert the std::vector parameter provided by the user into a std::set for use by libMesh's
  // System::add_variable method
  std::set<SubdomainID> blocks;
  const auto & block_param = parameters.get<std::vector<SubdomainName>>("block");
  for (const auto & subdomain_name : block_param)
  {
    SubdomainID blk_id = _mesh.getSubdomainID(subdomain_name);
    blocks.insert(blk_id);
  }
 
  const auto fe_type = MooseUtils::variableFEType(parameters);
  const auto fe_field_type = FEInterface::field_type(fe_type);
 
  unsigned int var_num;
 
  if (var_type == "ArrayMooseVariable")
  {
    if (fe_field_type == libMesh::TYPE_VECTOR)
      mooseError("Vector family type cannot be used in an array variable");
 
    std::vector<std::string> array_var_component_names;
    const bool has_array_names = parameters.isParamValid("array_var_component_names");
    if (has_array_names)
    {
      array_var_component_names =
          parameters.get<std::vector<std::string>>("array_var_component_names");
      if (array_var_component_names.size() != components)
        parameters.paramError("array_var_component_names",
                              "Must be the same size as 'components' (size ",
                              components,
                              ") for array variable '",
                              name,
                              "'");
    }
 
    // Build up the variable names
    std::vector<std::string> var_names;
    for (unsigned int i = 0; i < components; i++)
    {
      if (!has_array_names)
        array_var_component_names.push_back(std::to_string(i));
      var_names.push_back(name + "_" + array_var_component_names[i]);
    }
 
    // makes sure there is always a name, either the provided one or '1 2 3 ...'
    parameters.set<std::vector<std::string>>("array_var_component_names") =
        array_var_component_names;
 
    // The number returned by libMesh is the _last_ variable number... we want to hold onto the
    // _first_
    var_num = system().add_variable_array(var_names, fe_type, &blocks) - (components - 1);
 
    // Set as array variable
    if (parameters.isParamSetByUser("array") && !parameters.get<bool>("array"))
      parameters.paramError("array",
                            "Must be set to true for variable '",
                            name,
                            "' because 'components' > 1 (is an array variable)");
    parameters.set<bool>("array") = true;
  }
  else
  {
    if (parameters.isParamSetByUser("array_var_component_names"))
      parameters.paramError("array_var_component_names",
                            "Should not be set because this variable (",
                            name,
                            ") is a non-array variable");
    var_num = system().add_variable(name, fe_type, &blocks);
  }
 
  parameters.set<unsigned int>("_var_num") = var_num;
  parameters.set<SystemBase *>("_system_base") = this;
 
  for (THREAD_ID tid = 0; tid < numThreads(); tid++)
  {
    parameters.set<THREAD_ID>("tid") = tid;
    std::shared_ptr<MooseVariableBase> var =
        _factory.create<MooseVariableBase>(var_type, name, parameters, tid);
 
    _vars[tid].add(name, var);
 
    if (auto fe_var = dynamic_cast<MooseVariableFieldBase *>(var.get()))
    {
      auto required_size = var_num + components;
      if (required_size > _numbered_vars[tid].size())
        _numbered_vars[tid].resize(required_size);
      for (MooseIndex(components) component = 0; component < components; ++component)
        _numbered_vars[tid][var_num + component] = fe_var;
 
      if (auto * const functor = dynamic_cast<Moose::FunctorBase<ADReal> *>(fe_var))
        _subproblem.addFunctor(name, *functor, tid);
      else if (auto * const functor = dynamic_cast<Moose::FunctorBase<ADRealVectorValue> *>(fe_var))
        _subproblem.addFunctor(name, *functor, tid);
      else if (auto * const functor = dynamic_cast<Moose::FunctorBase<ADRealEigenVector> *>(fe_var))
        _subproblem.addFunctor(name, *functor, tid);
      else
        mooseError("This should be a functor");
    }
 
    if (auto scalar_var = dynamic_cast<MooseVariableScalar *>(var.get()))
    {
      if (auto * const functor = dynamic_cast<Moose::FunctorBase<ADReal> *>(scalar_var))
        _subproblem.addFunctor(name, *functor, tid);
      else
        mooseError("Scalar variables should be functors");
    }
 
    if (var->blockRestricted())
      for (const SubdomainID & id : var->blockIDs())
        for (MooseIndex(components) component = 0; component < components; ++component)
          _var_map[var_num + component].insert(id);
    else
      for (MooseIndex(components) component = 0; component < components; ++component)
        _var_map[var_num + component] = std::set<SubdomainID>();
  }
 
  // getMaxVariableNumber is an API method used in Rattlesnake
  if (var_num > _max_var_number)
    _max_var_number = var_num;
  _du_dot_du.resize(var_num + 1);
}

Referenced by AuxiliarySystem::addVariable().

◆ 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_name	Name of the nodal variable being used for copying into (name is from the exodusII file)
source_name	Name of the nodal variable being used for copying from (name is from the exodusII file)
timestep	Timestep in the file being used

Definition at line 1175 of file SystemBase.C.

{
  _var_to_copy.push_back(VarCopyInfo(dest_name, source_name, timestep));
}

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

◆ 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_name The name of the variable to be zeroed.

Reimplemented from SystemBase.

Definition at line 197 of file DisplacedSystem.h.

  {
    _undisplaced_system.addVariableToZeroOnJacobian(var_name);
  }

◆ 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_name The name of the variable to be zeroed.

Reimplemented from SystemBase.

Definition at line 188 of file DisplacedSystem.h.

  {
    _undisplaced_system.addVariableToZeroOnResidual(var_name);
  }

◆ 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_name	The name of the vector.
project	Whether 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.
type	What 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.

Definition at line 608 of file SystemBase.C.

{
  if (hasVector(vector_name))
    return getVector(vector_name);
 
  NumericVector<Number> & vec = system().add_vector(vector_name, project, type);
  return vec;
}

Referenced by SystemBase::addDotVectors(), NonlinearTimeIntegratorInterface::addVector(), PicardSolve::allocateStorage(), SecantSolve::allocateStorage(), SteffensenSolve::allocateStorage(), NonlinearSystemBase::getResidualNonTimeVector(), NonlinearSystemBase::getResidualTimeVector(), LinearFVGradientManager::initializeLinearFVGradientHistoryStorage(), 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_name	The name of the tag
project	Whether 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.
type	What 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.

Definition at line 620 of file SystemBase.C.

{
  if (!_subproblem.vectorTagExists(tag))
    mooseError("Cannot add tagged vector with TagID ",
               tag,
               " in system '",
               name(),
               "' because the tag does not exist in the problem");
 
  if (hasVector(tag))
  {
    auto & vec = getVector(tag);
 
    if (type != AUTOMATIC && vec.type() != type)
      mooseError("Cannot add tagged vector '",
                 _subproblem.vectorTagName(tag),
                 "', in system '",
                 name(),
                 "' because a vector with the same name was found with a different parallel type");
 
    return vec;
  }
 
  const auto vector_name = _subproblem.vectorTagName(tag);
  NumericVector<Number> & vec = system().add_vector(vector_name, project, type);
  associateVectorToTag(vec, tag);
 
  return vec;
}

◆ advanceStateHistory()

void SystemBase::advanceStateHistory ( Moose::SolutionIterationType iteration_type )

inherited

Advance solution vectors and additional system-owned state together.

Definition at line 1311 of file SystemBase.C.

{
  const bool skip_current_to_old =
      iteration_type == Moose::SolutionIterationType::Time && _skip_next_solution_to_old_copy;
  copyPreviousSolutions(iteration_type);
  copyAdditionalStateBackwards(iteration_type, skip_current_to_old);
}

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

◆ applyScalingFactors()

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

inherited

Applies scaling factors to the system's variables.

Parameters

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

Definition at line 1532 of file SystemBase.C.

{
  for (MooseIndex(_vars) thread = 0; thread < _vars.size(); ++thread)
  {
    auto & field_variables = _vars[thread].fieldVariables();
    for (MooseIndex(field_variables) i = 0, p = 0; i < field_variables.size(); ++i)
    {
      auto factors = field_variables[i]->arrayScalingFactor();
      for (unsigned int j = 0; j < field_variables[i]->count(); ++j, ++p)
        factors[j] /= inverse_scaling_factors[p];
 
      field_variables[i]->scalingFactor(factors);
    }
 
    auto offset = field_variables.size();
 
    auto & scalar_variables = _vars[thread].scalars();
    for (MooseIndex(scalar_variables) i = 0; i < scalar_variables.size(); ++i)
      scalar_variables[i]->scalingFactor(
          {1. / inverse_scaling_factors[offset + i] * scalar_variables[i]->scalingFactor()});
 
    if (thread == 0 && _verbose)
    {
      _console << "Automatic scaling factors:\n";
      auto original_flags = _console.flags();
      auto original_precision = _console.precision();
      _console.unsetf(std::ios_base::floatfield);
      _console.precision(6);
 
      for (const auto & field_variable : field_variables)
      {
        const auto & factors = field_variable->arrayScalingFactor();
        _console << "  " << field_variable->name() << ":";
        for (const auto i : make_range(field_variable->count()))
          _console << " " << factors[i];
        _console << "\n";
      }
      for (const auto & scalar_variable : scalar_variables)
        _console << "  " << scalar_variable->name() << ": " << scalar_variable->scalingFactor()
                 << "\n";
      _console << "\n" << std::endl;
 
      // restore state
      _console.flags(original_flags);
      _console.precision(original_precision);
    }
  }
}

Referenced by NonlinearSystemBase::computeScaling().

◆ assignMaxVarNDofsPerElem()

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

inlineinherited

assign the maximum element dofs

Definition at line 628 of file SystemBase.h.

628{ _max_var_n_dofs_per_elem = max_dofs; }

SystemBase::_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:1088

◆ assignMaxVarNDofsPerNode()

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

inlineinherited

assign the maximum node dofs

Definition at line 633 of file SystemBase.h.

633{ _max_var_n_dofs_per_node = max_dofs; }

SystemBase::_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:1091

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

  {
    _undisplaced_system.associateMatrixToTag(matrix, tag);
  }

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

  {
    _undisplaced_system.associateVectorToTag(vec, tag);
  }

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

  {
    _undisplaced_system.augmentSendList(send_list);
  }

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

126{ return _automatic_scaling; }

SystemBase::_automatic_scaling

bool _automatic_scaling

Whether to automatically scale the variables.

Definition SystemBase.h:1100

Referenced by SubProblem::automaticScaling(), and SubProblem::automaticScaling().

◆ automaticScaling() [2/2]

void SystemBase::automaticScaling ( bool automatic_scaling )

inlineinherited

Setter for whether we are performing automatic scaling.

Parameters

automatic_scaling A boolean representing whether we are performing automatic scaling

Definition at line 132 of file SystemBase.h.

132{ _automatic_scaling = automatic_scaling; }

◆ clearAllDofIndices()

void SystemBase::clearAllDofIndices ( )

inherited

Clear all dof indices from moose variables.

Definition at line 1630 of file SystemBase.C.

{
  for (auto & var_warehouse : _vars)
    var_warehouse.clearAllDofIndices();
}

Referenced by SubProblem::clearAllDofIndices().

◆ closeTaggedMatrices()

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

inherited

Close all matrices associated the tags.

Definition at line 1060 of file SystemBase.C.

{
  for (auto tag : tags)
    if (hasMatrix(tag))
      getMatrix(tag).close();
}

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

◆ closeTaggedVector()

void SystemBase::closeTaggedVector ( const TagID tag )

inherited

Close vector with the given tag.

Definition at line 651 of file SystemBase.C.

{
  if (!_subproblem.vectorTagExists(tag))
    mooseError("Cannot close vector with TagID ",
               tag,
               " in system '",
               name(),
               "' because that tag does not exist in the problem");
  else if (!hasVector(tag))
    mooseError("Cannot close vector tag with name '",
               _subproblem.vectorTagName(tag),
               "' in system '",
               name(),
               "' because there is no vector associated with that tag");
  getVector(tag).close();
}

Referenced by SystemBase::closeTaggedVectors().

◆ closeTaggedVectors()

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

inherited

Close all vectors for given tags.

Definition at line 669 of file SystemBase.C.

{
  for (const auto tag : tags)
    closeTaggedVector(tag);
}

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

◆ compute()

virtual void DisplacedSystem::compute ( ExecFlagType type )

inlineoverridevirtual

Compute time derivatives, auxiliary variables, etc.

Parameters

type	Our current execution stage

Implements SystemBase.

Definition at line 250 of file DisplacedSystem.h.

250{}

◆ computeVariables()

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

inlinevirtualinherited

Definition at line 902 of file SystemBase.h.

902{}

◆ computingScalingJacobian()

bool SystemBase::computingScalingJacobian ( ) const

inherited

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

Definition at line 1582 of file SystemBase.C.

{
  return _subproblem.computingScalingJacobian();
}

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

◆ copyAdditionalStateBackwards()

virtual void SystemBase::copyAdditionalStateBackwards	(	Moose::SolutionIterationType	,
		bool
	)

inlineprotectedvirtualinherited

Copy system-owned state not represented by solution vectors.

The first argument selects the solution history being advanced. The second indicates that state 0 must not overwrite state 1 while deeper states still shift; additional state must honor this to remain aligned with the solution history. Default implementation does nothing.

Reimplemented in AuxiliarySystem, and LinearSystem.

Definition at line 1013 of file SystemBase.h.

1013{}

Referenced by SystemBase::advanceStateHistory().

◆ copyOldSolutions()

void SystemBase::copyOldSolutions ( )

inherited

Copy the solution back in time (older -> old, etc).

Shifts the solutions backwards in time.

Definition at line 1323 of file SystemBase.C.

{
  copyPreviousSolutions(Moose::SolutionIterationType::Time);
}

◆ copyPreviousSolutions()

void SystemBase::copyPreviousSolutions ( const Moose::SolutionIterationType iteration_type )

inherited

Copy a specific type of solution back in time (current -> old -> older, etc).

Definition at line 1274 of file SystemBase.C.

{
  // Normally copy through old (index 1). For Time, optionally stop at older
  // and leave old unchanged.
  const bool skip_old =
      iteration_type == Moose::SolutionIterationType::Time && _skip_next_solution_to_old_copy;
 
  const auto num_states = getNumSolutionStates(iteration_type);
  if (num_states > 1)
  {
    const std::size_t stop = skip_old ? 1 : 0;
    for (std::size_t i = num_states - 1; i > stop; --i)
      solutionState(i, iteration_type) = solutionState(i - 1, iteration_type);
  }
 
  // Custom logic for changing state based on iteration type
  switch (iteration_type)
  {
    case Moose::SolutionIterationType::Time:
      _skip_next_solution_to_old_copy = false;
      if (solutionUDotOld())
        *solutionUDotOld() = *solutionUDot();
      if (solutionUDotDotOld())
        *solutionUDotDotOld() = *solutionUDotDot();
      break;
    case Moose::SolutionIterationType::Nonlinear:
      if (solutionPreviousNewton())
        *solutionPreviousNewton() = *currentSolution();
      break;
    case Moose::SolutionIterationType::MultiAppFixedPoint:
    case Moose::SolutionIterationType::MultiSystemFixedPoint:
    case Moose::SolutionIterationType::Count:
      break;
  }
}

Referenced by SystemBase::advanceStateHistory(), SystemBase::copyOldSolutions(), and SystemBase::copySolutionsBackwards().

◆ copySolutionsBackwards()

void SystemBase::copySolutionsBackwards ( )

virtualinherited

Copy current solution into old and older.

Definition at line 1258 of file SystemBase.C.

{
  system().update();
  copyPreviousSolutions(Moose::SolutionIterationType::Time);
  copyPreviousSolutions(Moose::SolutionIterationType::Nonlinear);
}

◆ copyStateHistoryBackwards()

void SystemBase::copyStateHistoryBackwards ( )

inherited

Copy solution vectors and additional system-owned state into older states.

Definition at line 1266 of file SystemBase.C.

{
  system().update();
  advanceStateHistory(Moose::SolutionIterationType::Time);
  advanceStateHistory(Moose::SolutionIterationType::Nonlinear);
}

◆ copyTimeIntegrators()

void SystemBase::copyTimeIntegrators ( const SystemBase & other_sys )

inherited

Copy time integrators from another system.

Definition at line 1684 of file SystemBase.C.

{
  _time_integrators = other_sys._time_integrators;
}

◆ copyVars()

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

inherited

Definition at line 1183 of file SystemBase.C.

{
  int n_steps = io.get_num_time_steps();
 
  bool did_copy = false;
  for (const auto & vci : _var_to_copy)
  {
    int timestep = -1;
 
    if (vci._timestep == "LATEST")
      // Use the last time step in the file from which to retrieve the solution
      timestep = n_steps;
    else
    {
      timestep = MooseUtils::convert<int>(vci._timestep);
      if (timestep > n_steps)
        mooseError("Invalid value passed as \"initial_from_file_timestep\". Expected \"LATEST\" or "
                   "a valid integer between 1 and ",
                   n_steps,
                   " inclusive, received ",
                   vci._timestep);
    }
 
    did_copy = true;
 
    if (hasVariable(vci._dest_name))
    {
      const auto & var = getVariable(0, vci._dest_name);
      if (var.isArray())
      {
        const auto & array_var = getFieldVariable<RealEigenVector>(0, vci._dest_name);
        for (MooseIndex(var.count()) i = 0; i < var.count(); ++i)
        {
          const auto & exodus_var = var.arrayVariableComponent(i);
          const auto & system_var = array_var.componentName(i);
          if (var.isNodal())
            io.copy_nodal_solution(system(), exodus_var, system_var, timestep);
          else
            io.copy_elemental_solution(system(), exodus_var, system_var, timestep);
        }
      }
      else
      {
        if (var.isNodal())
          io.copy_nodal_solution(system(), vci._dest_name, vci._source_name, timestep);
        else
          io.copy_elemental_solution(system(), vci._dest_name, vci._source_name, timestep);
      }
    }
    else if (hasScalarVariable(vci._dest_name))
      io.copy_scalar_solution(system(), {vci._dest_name}, {vci._source_name}, timestep);
    else
      mooseError("Unrecognized variable ", vci._dest_name, " in variables to copy.");
  }
 
  if (did_copy)
    solution().close();
}

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

  {
    return _undisplaced_system.currentSolution();
  }

◆ customSetup()

void SystemBase::customSetup ( const ExecFlagType & exec_type )

virtualinherited

Reimplemented in AuxiliarySystem, and NonlinearSystemBase.

Definition at line 1602 of file SystemBase.C.

{
  for (THREAD_ID tid = 0; tid < numThreads(); tid++)
    _vars[tid].customSetup(exec_type);
}

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

◆ deactivateAllMatrixTags()

void SystemBase::deactivateAllMatrixTags ( )

virtualinherited

Make matrices inactive.

Definition at line 1119 of file SystemBase.C.

{
  auto num_matrix_tags = _subproblem.numMatrixTags();
 
  _matrix_tag_active_flags.resize(num_matrix_tags);
 
  for (decltype(num_matrix_tags) tag = 0; tag < num_matrix_tags; tag++)
    _matrix_tag_active_flags[tag] = false;
  _active_tagged_matrices.clear();
}

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

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

  {
    return _undisplaced_system.defaultMatrixTags();
  }

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

  {
    return _undisplaced_system.defaultVectorTags();
  }

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

  {
    _undisplaced_system.disassociateDefaultMatrixTags();
  }

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

  {
    _undisplaced_system.disassociateDefaultVectorTags();
  }

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

  {
    _undisplaced_system.disassociateMatrixFromTag(matrix, tag);
  }

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

  {
    _undisplaced_system.disassociateMatrixFromTag(tag);
  }

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

  {
    _undisplaced_system.disassociateVectorFromTag(vec, 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.

  {
    _undisplaced_system.disassociateVectorFromTag(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 1169 of file SystemBase.C.

{
  return system().get_dof_map();
}

◆ duDotDotDu() [1/2]

virtual const Number & DisplacedSystem::duDotDotDu ( ) const

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 152 of file DisplacedSystem.h.

152{ return _undisplaced_system.duDotDotDu(); }

SystemBase::duDotDotDu

virtual Number & duDotDotDu()

Definition SystemBase.h:288

◆ duDotDotDu() [2/2]

virtual Number & DisplacedSystem::duDotDotDu ( )

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 150 of file DisplacedSystem.h.

150{ return _undisplaced_system.duDotDotDu(); }

◆ duDotDu()

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

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 298 of file DisplacedSystem.h.

{
  return _undisplaced_system.duDotDu(var_num);
}

◆ 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::duDotDus

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

Definition SystemBase.h:287

◆ feProblem() [1/2]

FEProblemBase & SystemBase::feProblem ( )

inlineinherited

Definition at line 104 of file SystemBase.h.

104{ return _fe_problem; }

SystemBase::_fe_problem

FEProblemBase & _fe_problem

the governing finite element/volume problem

Definition SystemBase.h:1031

Referenced by LinearFVGradientManager::checkRestartedGradientHistory(), FVGradientMethod::computeGradient(), FVGreenGaussGradient::computeGradientWithoutLimiter(), DMMooseGetEmbedding_Private(), DMSetUp_Moose_Pre(), and AuxiliarySystem::registerFVGradient().

◆ feProblem() [2/2]

const FEProblemBase & SystemBase::feProblem ( ) const

inlineinherited

Definition at line 105 of file SystemBase.h.

105{ return _fe_problem; }

◆ 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 1068 of file SystemBase.C.

{
  for (auto tag : tags)
    if (hasMatrix(tag))
      getMatrix(tag).flush();
}

◆ getActualFieldVariable() [1/2]

template<typename T >

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

inherited

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

Definition at line 120 of file SystemBase.C.

{
  return *_vars[tid].getActualFieldVariable<T>(var_name);
}

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

◆ getActualFieldVariable() [2/2]

template<typename T >

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

inherited

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

Definition at line 141 of file SystemBase.C.

{
  return *_vars[tid].getActualFieldVariable<T>(var_number);
}

◆ getFieldVariable() [1/2]

template<typename T >

template MooseVariableFE< RealEigenVector > & SystemBase::getFieldVariable< RealEigenVector >	(	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

tid	Thread id
var_name	variable name

Returns: reference the variable (class)

Definition at line 113 of file SystemBase.C.

{
  return *_vars[tid].getFieldVariable<T>(var_name);
}

Referenced by Marker::getMarkerValue().

◆ getFieldVariable() [2/2]

template<typename T >

template MooseVariableFE< RealEigenVector > & SystemBase::getFieldVariable< RealEigenVector >	(	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

tid	Thread id
var_number	libMesh variable number

Returns: reference the variable (class)

Definition at line 134 of file SystemBase.C.

{
  return *_vars[tid].getFieldVariable<T>(var_number);
}

◆ 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 127 of file SystemBase.C.

{
  return *_vars[tid].getFVVariable<T>(var_name);
}

◆ getMatrix() [1/2]

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

inlineoverridevirtual

Get a raw SparseMatrix.

Reimplemented from SystemBase.

Definition at line 240 of file DisplacedSystem.h.

  {
    return _undisplaced_system.getMatrix(tag);
  }

◆ getMatrix() [2/2]

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

inlineoverridevirtual

Get a raw SparseMatrix.

Reimplemented from SystemBase.

Definition at line 236 of file DisplacedSystem.h.

  {
    return _undisplaced_system.getMatrix(tag);
  }

◆ getMaxVariableNumber()

unsigned int SystemBase::getMaxVariableNumber ( ) const

inlineinherited

Returns the maximum number of all variables on the system.

Definition at line 900 of file SystemBase.h.

900{ return _max_var_number; }

◆ 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 616 of file SystemBase.h.

616{ return _max_var_n_dofs_per_elem; }

Referenced by Moose::globalDofIndexToDerivative().

◆ 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 623 of file SystemBase.h.

623{ return _max_var_n_dofs_per_node; }

◆ 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 243 of file SystemBase.C.

{
  Order order = CONSTANT;
  const std::vector<MooseVariableFieldBase *> & vars = _vars[0].fieldVariables();
  for (const auto & var : vars)
  {
    FEType fe_type = var->feType();
    if (fe_type.default_quadrature_order() > order)
      order = fe_type.default_quadrature_order();
  }
 
  return order;
}

◆ getNumSolutionStates()

std::size_t SystemBase::getNumSolutionStates ( const Moose::SolutionIterationType iteration_type ) const

inlineinherited

Get the number of solution states (0 = current, 1 = current + old, ...) for the given iteration type.

Definition at line 1161 of file SystemBase.h.

{
  return getSolutionStates(iteration_type).size();
}

Referenced by SystemBase::copyPreviousSolutions(), SystemBase::hasSolutionState(), SystemBase::restoreOldSolutions(), SystemBase::saveOldSolutions(), and SystemBase::solutionState().

◆ 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

tid	Thread id
var_name	A string which is the name of the variable to get.

Returns: reference the variable (class)

Definition at line 147 of file SystemBase.C.

{
  MooseVariableScalar * var = dynamic_cast<MooseVariableScalar *>(_vars[tid].getVariable(var_name));
  if (!var)
    mooseError("Scalar variable '" + var_name + "' does not exist in this system");
  return *var;
}

◆ 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

tid	Thread id
var_number	libMesh variable number

Returns: reference the variable (class)

Definition at line 156 of file SystemBase.C.

{
  MooseVariableScalar * var =
      dynamic_cast<MooseVariableScalar *>(_vars[tid].getVariable(var_number));
  if (!var)
    mooseError("variable #" + Moose::stringify(var_number) + " does not exist in this system");
  return *var;
}

◆ getScalarVariables()

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

inlineinherited

Definition at line 789 of file SystemBase.h.

  {
    return _vars[tid].scalars();
  }

Referenced by Assembly::addResidualScalar(), ODEKernel::computeJacobian(), ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), AuxiliarySystem::computeScalarVars(), SystemBase::initSolutionState(), NonlinearThread::onElement(), Assembly::prepareOffDiagScalar(), and Assembly::prepareScalar().

◆ getSolutionStates() [1/2]

std::vector< NumericVector< Number > * > & SystemBase::getSolutionStates ( const Moose::SolutionIterationType iteration_type )

inlineprivateinherited

Get all of the solution states (current, old, ...) for the given iteration type.

Definition at line 1126 of file SystemBase.h.

  {
    return const_cast<std::vector<NumericVector<Number> *> &>(
        cast_ptr<const SystemBase *>(this)->getSolutionStates(iteration_type));
  }

◆ getSolutionStates() [2/2]

const std::vector< NumericVector< Number > * > & SystemBase::getSolutionStates ( const Moose::SolutionIterationType iteration_type ) const

inlineinherited

Get all of the solution states (current, old, ...) for the given iteration type.

Definition at line 1151 of file SystemBase.h.

{
  const auto iteration_type_index = static_cast<std::size_t>(iteration_type);
  mooseAssert(iteration_type_index < static_cast<std::size_t>(Moose::SolutionIterationType::Count),
              "Invalid solution iteration type");
  mooseAssert(iteration_type_index < _solution_states.size(), "_solution_states sized incorrectly");
  return _solution_states[iteration_type_index];
}

Referenced by SystemBase::getNumSolutionStates(), SystemBase::needSolutionState(), SystemBase::solutionState(), SystemBase::solutionState(), and SystemBase::solutionStateParallelType().

◆ getStandardFieldVariableNames()

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

inherited

◆ getSubdomainsForVar() [1/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_name The name of the variable

Returns: the set of subdomain ids where the variable is active (defined)

Definition at line 1724 of file SystemBase.C.

{
  return getSubdomainsForVar(getVariable(0, var_name).number());
}

◆ getSubdomainsForVar() [2/2]

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

inlineinherited

Definition at line 794 of file SystemBase.h.

  {
    return _var_map.at(var_number);
  }

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

◆ 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 1700 of file SystemBase.C.

{
  const auto * const ti = queryTimeIntegrator(var_num);
 
  if (ti)
    return *ti;
  else
    mooseError("No time integrator found that integrates variable number ",
               std::to_string(var_num));
}

Referenced by AB2PredictorCorrector::estimateTimeError().

◆ getTimeIntegrators()

const std::vector< std::shared_ptr< TimeIntegrator > > & SystemBase::getTimeIntegrators ( )

inherited

Returns: All the time integrators owned by this system

Definition at line 1712 of file SystemBase.C.

{
  return _time_integrators;
}

◆ 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

tid	Thread id
var_name	variable name

Returns: reference the variable (class)

Definition at line 92 of file SystemBase.C.

{
  MooseVariableFieldBase * var =
      dynamic_cast<MooseVariableFieldBase *>(_vars[tid].getVariable(var_name));
  if (!var)
    mooseError("Variable '", var_name, "' does not exist in this system");
  return *var;
}

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

◆ 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

tid	Thread id
var_number	libMesh variable number

Returns: reference the variable (class)

Definition at line 102 of file SystemBase.C.

{
  if (var_number < _numbered_vars[tid].size())
    if (_numbered_vars[tid][var_number])
      return *_numbered_vars[tid][var_number];
 
  mooseError("Variable #", Moose::stringify(var_number), " does not exist in this system");
}

◆ 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_number The number of the variable

Returns: the set of subdomain ids where the variable is active (defined)

Definition at line 166 of file SystemBase.C.

{
  mooseAssert(_var_map.find(var_number) != _var_map.end(), "Variable does not exist.");
  if (_var_map[var_number].empty())
    return nullptr;
  else
    return &_var_map[var_number];
}

Referenced by PhysicsBasedPreconditioner::addSystem().

◆ 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 875 of file SystemBase.h.

875{ return _var_all_dof_indices; }

SystemBase::_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:1109

◆ getVariableNames()

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

inlineinherited

Definition at line 893 of file SystemBase.h.

893{ return _vars[0].names(); }

Referenced by MooseEigenSystem::buildSystemDoFIndices(), NonlinearSystemBase::checkKernelCoverage(), MFEMProblem::getAuxVariableNames(), SystemBase::hasVariable(), SystemBase::isArrayVariable(), and SingleMatrixPreconditioner::SingleMatrixPreconditioner().

◆ getVariables()

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

inlineinherited

◆ getVector() [1/4]

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

overridevirtual

Reimplemented from SystemBase.

Definition at line 47 of file DisplacedSystem.C.

{
  if (_sys.have_vector(name))
    return _sys.get_vector(name);
  else
    return _undisplaced_system.getVector(name);
}

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

{
  if (_sys.have_vector(name))
    return _sys.get_vector(name);
  else
    return _undisplaced_system.getVector(name);
}

◆ getVector() [3/4]

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

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 38 of file DisplacedSystem.h.

  {
    return _undisplaced_system.getVector(tag_id);
  }

◆ getVector() [4/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.

  {
    return _undisplaced_system.getVector(tag_id);
  }

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

  {
    return _undisplaced_system.hasMatrix(tag_id);
  }

◆ hasScalarVariable()

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

virtualinherited

Definition at line 876 of file SystemBase.C.

{
  if (system().has_variable(var_name))
    return system().variable_type(var_name).family == SCALAR;
  else
    return false;
}

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

◆ 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 291 of file DisplacedSystem.h.

{
  return _undisplaced_system.hasSolutionState(state, iteration_type);
}

◆ hasVarCopy()

bool SystemBase::hasVarCopy ( ) const

inlineinherited

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

Definition at line 921 of file SystemBase.h.

921{ return _var_to_copy.size() > 0; }

◆ hasVariable()

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

virtualinherited

Query a system for a variable.

Parameters

var_name name of the variable

Returns: true if the variable exists

Definition at line 851 of file SystemBase.C.

{
  auto & names = getVariableNames();
  if (system().has_variable(var_name))
    return system().variable_type(var_name).family != SCALAR;
  if (std::find(names.begin(), names.end(), var_name) != names.end())
    // array variable
    return true;
  else
    return false;
}

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

◆ hasVector() [1/2]

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

inherited

Check if the named vector exists in the system.

Definition at line 924 of file SystemBase.C.

{
  return system().have_vector(name);
}

Referenced by FEProblemBase::addCachedResidualDirectly(), Assembly::addCachedResiduals(), Assembly::addResidual(), Assembly::addResidualLower(), Assembly::addResidualNeighbor(), Assembly::addResidualScalar(), SystemBase::addVector(), SystemBase::addVector(), Assembly::cacheResidual(), Assembly::cacheResidualLower(), Assembly::cacheResidualNeighbor(), SystemBase::closeTaggedVector(), FEProblemBase::computeBounds(), NonlinearSystemBase::computeResidualTags(), CentralDifference::computeTimeDerivatives(), SystemBase::disassociateVectorFromTag(), SystemBase::getVector(), SystemBase::getVector(), hasVector(), MooseVariableScalar::reinit(), SystemBase::removeVector(), SubProblem::selectVectorTagsFromSystem(), NonlinearSystemBase::setPreviousNewtonSolution(), TaggingInterface::setResidual(), TaggingInterface::setResidual(), TaggingInterface::setResidual(), SystemBase::solutionPreviousNewton(), SystemBase::solutionPreviousNewton(), and SystemBase::zeroTaggedVector().

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

  {
    return _undisplaced_system.hasVector(tag_id);
  }

◆ initializeObjects()

virtual void SystemBase::initializeObjects ( )

inlinevirtualinherited

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

Definition at line 177 of file SystemBase.h.

177{}

◆ initialSetup()

void SystemBase::initialSetup ( )

virtualinherited

Setup Functions.

Reimplemented in AuxiliarySystem, LinearSystem, and NonlinearSystemBase.

Definition at line 1588 of file SystemBase.C.

{
  for (THREAD_ID tid = 0; tid < numThreads(); tid++)
    _vars[tid].initialSetup();
}

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

◆ initSolutionState()

void DisplacedSystem::initSolutionState ( )

inlineoverridevirtual

Initializes the solution state.

Reimplemented from SystemBase.

Definition at line 263 of file DisplacedSystem.h.

{
  _undisplaced_system.initSolutionState();
}

◆ isArrayVariable()

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

virtualinherited

If a variable is an array variable.

Definition at line 864 of file SystemBase.C.

{
  auto & names = getVariableNames();
  if (!system().has_variable(var_name) &&
      std::find(names.begin(), names.end(), var_name) != names.end())
    // array variable
    return true;
  else
    return false;
}

◆ isScalarVariable()

bool SystemBase::isScalarVariable ( unsigned int var_name ) const

virtualinherited

Definition at line 885 of file SystemBase.C.

{
  return (system().variable(var_num).type().family == SCALAR);
}

Referenced by Assembly::initNonlocalCoupling().

◆ jacobianSetup()

void SystemBase::jacobianSetup ( )

virtualinherited

Reimplemented in AuxiliarySystem, LinearSystem, and NonlinearSystemBase.

Definition at line 1623 of file SystemBase.C.

{
  for (THREAD_ID tid = 0; tid < numThreads(); tid++)
    _vars[tid].jacobianSetup();
}

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

◆ matrixTagActive()

bool SystemBase::matrixTagActive ( TagID tag ) const

virtualinherited

If or not a matrix tag is active.

Definition at line 1149 of file SystemBase.C.

{
  mooseAssert(_subproblem.matrixTagExists(tag), "Matrix tag " << tag << " does not exist");
 
  return tag < _matrix_tag_active_flags.size() && _matrix_tag_active_flags[tag];
}

◆ mesh() [1/2]

MooseMesh & SystemBase::mesh ( )

inlineinherited

Definition at line 100 of file SystemBase.h.

100{ return _mesh; }

Referenced by CreateDisplacedProblemAction::addProxyRelationshipManagers(), DMMooseGetEmbedding_Private(), DMSetUp_Moose_Pre(), LinearFVGradientManager::initializeContainer(), LinearFVGradientManager::initializeLinearFVGradientHistoryStorage(), SolutionIC::initialSetup(), ComputeNodalKernelJacobiansThread::onNode(), ComputeNodalKernelsThread::onNode(), and ComputeNodalUserObjectsThread::onNode().

◆ mesh() [2/2]

const MooseMesh & SystemBase::mesh ( ) const

inlineinherited

Definition at line 101 of file SystemBase.h.

101{ return _mesh; }

◆ name()

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

virtualinherited

Definition at line 1362 of file SystemBase.C.

{
  return system().name();
}

◆ needSolutionState()

void DisplacedSystem::needSolutionState	(	const unsigned int	state,
		Moose::SolutionIterationType	iteration_type = `Moose::SolutionIterationType::Time`,
		libMesh::ParallelType	parallel_type = `GHOSTED`
	)

inlineoverridevirtual

Registers that the solution state state is needed.

Reimplemented from SystemBase.

Definition at line 283 of file DisplacedSystem.h.

{
  _undisplaced_system.needSolutionState(state, iteration_type, parallel_type);
}

◆ 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 900 of file SystemBase.C.

{
  unsigned int n = 0;
  for (auto & var : _vars[0].fieldVariables())
    n += var->count();
 
  return n;
}

Referenced by SystemBase::nVariables().

◆ 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 910 of file SystemBase.C.

{
  unsigned int n = 0;
  for (auto & var : _vars[0].fieldVariables())
    if (var->isFV())
      n += var->count();
 
  return n;
}

◆ nonTimeVectorTag()

virtual TagID DisplacedSystem::nonTimeVectorTag ( ) const

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 52 of file DisplacedSystem.h.

52{ return _undisplaced_system.nonTimeVectorTag(); }

SystemBase::nonTimeVectorTag

virtual TagID nonTimeVectorTag() const

Definition SystemBase.h:333

◆ number()

unsigned int SystemBase::number ( ) const

inherited

Gets the number of this system.

Returns: The number of this system

Definition at line 1157 of file SystemBase.C.

{
  return system().number();
}

◆ numThreads()

THREAD_ID SystemBase::numThreads ( ) const

inherited

Returns: the number of threads the associated application uses (see MooseApp::numThreads())

Definition at line 89 of file SystemBase.C.

89{ return _app.numThreads(); }

MooseApp::numThreads

THREAD_ID numThreads() const

Returns the number of threads this application uses.

Definition MooseApp.h:421

SystemBase::_app

MooseApp & _app

Definition SystemBase.h:1033

◆ nVariables()

unsigned int SystemBase::nVariables ( ) const

virtualinherited

Get the number of variables in this system.

Returns: the number of variables

Definition at line 891 of file SystemBase.C.

{
  unsigned int n = nFieldVariables();
  n += _vars[0].scalars().size();
 
  return n;
}

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

◆ oldSolutionStateVectorName()

TagName SystemBase::oldSolutionStateVectorName	(	const unsigned int	state,
		Moose::SolutionIterationType	iteration_type
	)		const

privateinherited

Gets the vector name used for an old (not current) solution state.

Definition at line 1403 of file SystemBase.C.

{
  mooseAssert(state != 0, "Not an old state");
  mooseAssert(static_cast<unsigned short>(iteration_type) <
                  static_cast<unsigned short>(Moose::SolutionIterationType::Count),
              "Invalid iteration_type");
 
  switch (iteration_type)
  {
    case Moose::SolutionIterationType::Time:
      if (state == 1)
        return Moose::OLD_SOLUTION_TAG;
      else if (state == 2)
        return Moose::OLDER_SOLUTION_TAG;
      break;
    case Moose::SolutionIterationType::Nonlinear:
      if (state == 1)
        return Moose::PREVIOUS_NL_SOLUTION_TAG;
      break;
    case Moose::SolutionIterationType::MultiAppFixedPoint:
      if (state == 1)
        return Moose::PREVIOUS_MULTIAPP_FP_SOLUTION_TAG;
      break;
    case Moose::SolutionIterationType::MultiSystemFixedPoint:
      if (state == 1)
        return Moose::PREVIOUS_MULTISYSTEM_FP_SOLUTION_TAG;
      break;
    case Moose::SolutionIterationType::Count:
      break;
  }
 
  return "solution_state_" + std::to_string(state) + "_" + Moose::stringify(iteration_type);
}

Referenced by SystemBase::needSolutionState(), and SystemBase::solutionState().

◆ operator=()

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

delete

◆ postInit()

virtual void SystemBase::postInit ( )

inlinevirtualinherited

Reimplemented in NonlinearEigenSystem.

Definition at line 166 of file SystemBase.h.

166{}

Referenced by NonlinearEigenSystem::postInit().

◆ prefix()

std::string SystemBase::prefix ( ) const

inherited

Returns: The prefix used for this system for solver settings for PETSc. This prefix is used to prevent collision of solver settings for different systems. Note that this prefix does not have a leading dash so it's appropriate for passage straight to PETSc APIs

Definition at line 1730 of file SystemBase.C.

{
  return system().prefix_with_name() ? system().prefix() : "";
}

Referenced by FieldSplitPreconditioner::FieldSplitPreconditioner(), MoosePreconditioner::initialSetup(), and FieldSplitPreconditioner::prefix().

◆ 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 LinearSystem, NonlinearSystemBase, and SolverSystem.

Definition at line 160 of file SystemBase.h.

160{}

Referenced by SolverSystem::preInit().

◆ prepare()

void SystemBase::prepare ( THREAD_ID tid )

virtualinherited

Prepare the system for use.

Parameters

tid	ID of the thread

Definition at line 258 of file SystemBase.C.

{
  if (_subproblem.hasActiveElementalMooseVariables(tid))
  {
    const std::set<MooseVariableFieldBase *> & active_elemental_moose_variables =
        _subproblem.getActiveElementalMooseVariables(tid);
    const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
    for (const auto & var : vars)
      var->clearDofIndices();
 
    for (const auto & var : active_elemental_moose_variables)
      if (&(var->sys()) == this)
        var->prepare();
  }
  else
  {
    const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
    for (const auto & var : vars)
      var->prepare();
  }
}

Referenced by SubProblem::reinitElemFaceRef().

◆ 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

tid	ID of the thread
resize_data	Pass True if this system needs to resize residual and jacobian datastructures based on preparing this face

Definition at line 281 of file SystemBase.C.

{
  // We only need to do something if the element prepare was restricted
  if (_subproblem.hasActiveElementalMooseVariables(tid))
  {
    const std::set<MooseVariableFieldBase *> & active_elemental_moose_variables =
        _subproblem.getActiveElementalMooseVariables(tid);
 
    std::vector<MooseVariableFieldBase *> newly_prepared_vars;
 
    const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
    for (const auto & var : vars)
    {
      mooseAssert(&var->sys() == this,
                  "I will cry if we store variables in our warehouse that don't belong to us");
 
      // If it wasn't in the active list, we need to prepare it. This has the potential to duplicate
      // prepare if we have these conditions:
      //
      // 1. We have a displaced problem
      // 2. We are using AD
      // 3. We are not using global AD indexing
      //
      // But I think I would rather risk duplicate prepare than introduce an additional member set
      // variable for tracking prepared variables. Set insertion is slow and some simulations have a
      // ton of variables
      if (!active_elemental_moose_variables.count(var))
      {
        var->prepare();
        newly_prepared_vars.push_back(var);
      }
    }
 
    // Make sure to resize the residual and jacobian datastructures for all the new variables
    if (resize_data)
      for (const auto var_ptr : newly_prepared_vars)
      {
        _subproblem.assembly(tid, number()).prepareVariable(var_ptr);
        if (_subproblem.checkNonlocalCouplingRequirement())
          _subproblem.assembly(tid, number()).prepareVariableNonlocal(var_ptr);
      }
  }
}

◆ prepareLowerD()

void SystemBase::prepareLowerD ( THREAD_ID tid )

virtualinherited

Prepare the system for use for lower dimensional elements.

Parameters

tid	ID of the thread

Definition at line 334 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
    var->prepareLowerD();
}

Referenced by SubProblem::reinitLowerDElem().

◆ prepareNeighbor()

void SystemBase::prepareNeighbor ( THREAD_ID tid )

virtualinherited

Prepare the system for use.

Parameters

tid	ID of the thread

Definition at line 326 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
    var->prepareNeighbor();
}

Referenced by SubProblem::reinitNeighborFaceRef().

◆ 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 1690 of file SystemBase.C.

{
  for (auto & ti : _time_integrators)
    if (ti->integratesVar(var_num))
      return ti.get();
 
  return nullptr;
}

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

◆ 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 AuxiliarySystem, LinearSystem, and NonlinearEigenSystem.

Definition at line 172 of file SystemBase.h.

172{}

Referenced by NonlinearEigenSystem::reinit().

◆ reinitElem()

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

virtualinherited

Reinit an element assembly info.

Parameters

elem	Which element we are reinitializing for
tid	ID of the thread

Reimplemented in AuxiliarySystem.

Definition at line 342 of file SystemBase.C.

{
  if (_subproblem.hasActiveElementalMooseVariables(tid))
  {
    const std::set<MooseVariableFieldBase *> & active_elemental_moose_variables =
        _subproblem.getActiveElementalMooseVariables(tid);
    for (const auto & var : active_elemental_moose_variables)
      if (&(var->sys()) == this)
        var->computeElemValues();
  }
  else
  {
    const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
    for (const auto & var : vars)
      var->computeElemValues();
  }
 
  if (system().has_static_condensation())
    for (auto & [tag, matrix] : _active_tagged_matrices)
    {
      libmesh_ignore(tag);
      cast_ptr<libMesh::StaticCondensation *>(matrix)->set_current_elem(*elem);
    }
}

◆ reinitElemFace()

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

virtualinherited

Reinit assembly info for a side of an element.

Parameters

elem	The element
side	Side of of the element
tid	Thread ID

Reimplemented in AuxiliarySystem.

Definition at line 368 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
    var->computeElemValuesFace();
}

Referenced by NonlinearThread::onInterfaceWithHRefinementMismatch(), and SubProblem::reinitElemFaceRef().

◆ reinitLowerD()

void SystemBase::reinitLowerD ( THREAD_ID tid )

virtualinherited

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

Definition at line 392 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
    var->computeLowerDValues();
}

Referenced by SubProblem::reinitLowerDElem().

◆ 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 384 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
    var->computeNeighborValues();
}

◆ 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 376 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
    var->computeNeighborValuesFace();
}

Referenced by SubProblem::reinitNeighborFaceRef().

◆ reinitNode()

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

virtualinherited

Reinit nodal assembly info.

Parameters

node	Node to reinit for
tid	Thread ID

Definition at line 400 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
  {
    var->reinitNode();
    if (var->isNodalDefined())
      var->computeNodalValues();
  }
}

◆ reinitNodeFace()

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

virtualinherited

Reinit nodal assembly info on a face.

Parameters

node	Node to reinit
bnd_id	Boundary ID
tid	Thread ID

Reimplemented in NonlinearSystemBase.

Definition at line 412 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
  {
    var->reinitNode();
    if (var->isNodalDefined())
      var->computeNodalValues();
  }
}

◆ reinitNodes()

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

virtualinherited

Reinit variables at a set of nodes.

Parameters

nodes	List of node ids to reinit
tid	Thread ID

Definition at line 424 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
  {
    var->reinitNodes(nodes);
    var->computeNodalValues();
  }
}

Referenced by SubProblem::reinitNodes().

◆ reinitNodesNeighbor()

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

virtualinherited

Reinit variables at a set of neighbor nodes.

Parameters

nodes	List of node ids to reinit
tid	Thread ID

Definition at line 435 of file SystemBase.C.

{
  const std::vector<MooseVariableFieldBase *> & vars = _vars[tid].fieldVariables();
  for (const auto & var : vars)
  {
    var->reinitNodesNeighbor(nodes);
    var->computeNodalNeighborValues();
  }
}

Referenced by SubProblem::reinitNodesNeighbor().

◆ reinitScalars()

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

virtualinherited

Reinit scalar varaibles.

Parameters

tid	Thread ID
reinit_for_derivative_reordering	A flag indicating whether we are reinitializing for the purpose of re-ordering derivative information for ADNodalBCs

Definition at line 446 of file SystemBase.C.

{
  const std::vector<MooseVariableScalar *> & vars = _vars[tid].scalars();
  for (const auto & var : vars)
    var->reinit(reinit_for_derivative_reordering);
}

◆ removeMatrix()

void SystemBase::removeMatrix ( TagID tag )

inherited

Removes a matrix with a given tag.

Parameters

tag_name The name of the tag

Definition at line 590 of file SystemBase.C.

{
  if (!_subproblem.matrixTagExists(tag_id))
    mooseError("Cannot remove the matrix with TagID ",
               tag_id,
               "\nin system '",
               name(),
               "', because that tag does not exist in the problem");
 
  if (hasMatrix(tag_id))
  {
    const auto matrix_name = _subproblem.matrixTagName(tag_id);
    system().remove_matrix(matrix_name);
    _tagged_matrices[tag_id] = nullptr;
  }
}

◆ removeVector() [1/2]

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

inherited

Remove a vector from the system with the given name.

Definition at line 1356 of file SystemBase.C.

{
  system().remove_vector(name);
}

Referenced by SystemBase::restoreOldSolutions().

◆ removeVector() [2/2]

void SystemBase::removeVector ( TagID tag_id )

inherited

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

Parameters

tag_id Tag ID

Definition at line 702 of file SystemBase.C.

{
  if (!_subproblem.vectorTagExists(tag_id))
    mooseError("Cannot remove the vector with TagID ",
               tag_id,
               "\nin system '",
               name(),
               "', because that tag does not exist in the problem");
 
  if (hasVector(tag_id))
  {
    auto vector_name = _subproblem.vectorTagName(tag_id);
    system().remove_vector(vector_name);
    _tagged_vectors[tag_id] = nullptr;
  }
}

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

  {
    return _undisplaced_system.residualCopy();
  }

◆ residualGhosted()

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

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 164 of file DisplacedSystem.h.

  {
    return _undisplaced_system.residualGhosted();
  }

◆ residualSetup()

void SystemBase::residualSetup ( )

virtualinherited

Reimplemented in AuxiliarySystem, LinearSystem, and NonlinearSystemBase.

Definition at line 1616 of file SystemBase.C.

{
  for (THREAD_ID tid = 0; tid < numThreads(); tid++)
    _vars[tid].residualSetup();
}

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

◆ residualVectorTag()

virtual TagID DisplacedSystem::residualVectorTag ( ) const

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 43 of file DisplacedSystem.h.

  {
    return _undisplaced_system.residualVectorTag();
  }

◆ restoreAdditionalStates()

virtual void SystemBase::restoreAdditionalStates ( )

inlineprotectedvirtualinherited

Restore system-owned state not represented by solution vectors.

Default implementation does nothing.

Reimplemented in AuxiliarySystem, and LinearSystem.

Definition at line 1019 of file SystemBase.h.

1019{}

Referenced by SystemBase::restoreStateHistory().

◆ restoreOldSolutions()

void SystemBase::restoreOldSolutions ( )

virtualinherited

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

Definition at line 543 of file SystemBase.C.

{
  const auto num_states = getNumSolutionStates(Moose::SolutionIterationType::Time);
  if (num_states > 1)
    for (unsigned int i = 1; i <= num_states - 1; ++i)
      if (_saved_solution_states[i])
      {
        solutionState(i) = *(_saved_solution_states[i]);
        removeVector("save_solution_state_" + std::to_string(i));
        _saved_solution_states[i] = nullptr;
      }
 
  if (_saved_dot_old && solutionUDotOld())
  {
    *solutionUDotOld() = *_saved_dot_old;
    removeVector("save_solution_dot_old");
    _saved_dot_old = nullptr;
  }
  if (_saved_dotdot_old && solutionUDotDotOld())
  {
    *solutionUDotDotOld() = *_saved_dotdot_old;
    removeVector("save_solution_dotdot_old");
    _saved_dotdot_old = nullptr;
  }
}

◆ restoreSolutions()

void SystemBase::restoreSolutions ( )

virtualinherited

Restore current solutions (call after your solve failed)

Reimplemented in SolverSystem.

Definition at line 1332 of file SystemBase.C.

{
  if (!hasSolutionState(1))
    mooseError("Cannot restore solutions without old solution");
 
  *(const_cast<NumericVector<Number> *&>(currentSolution())) = solutionOld();
  solution() = solutionOld();
  if (solutionUDotOld())
    *solutionUDot() = *solutionUDotOld();
  if (solutionUDotDotOld())
    *solutionUDotDot() = *solutionUDotDotOld();
  if (solutionPreviousNewton())
    *solutionPreviousNewton() = solutionOld();
  system().update();
}

Referenced by SolverSystem::restoreSolutions(), and SystemBase::restoreStateHistory().

◆ restoreStateHistory()

void SystemBase::restoreStateHistory ( )

inherited

Restore solution vectors and additional system-owned state together.

Definition at line 1349 of file SystemBase.C.

{
  restoreSolutions();
  restoreAdditionalStates();
}

◆ saveOldSolutions()

void SystemBase::saveOldSolutions ( )

virtualinherited

Save the old and older solutions.

Definition at line 512 of file SystemBase.C.

{
  const auto num_states = getNumSolutionStates(Moose::SolutionIterationType::Time);
  if (num_states > 1)
  {
    _saved_solution_states.resize(num_states);
    for (unsigned int i = 1; i <= num_states - 1; ++i)
      if (!_saved_solution_states[i])
        _saved_solution_states[i] =
            &addVector("save_solution_state_" + std::to_string(i), false, PARALLEL);
 
    for (unsigned int i = 1; i <= num_states - 1; ++i)
      *(_saved_solution_states[i]) = solutionState(i);
  }
 
  if (!_saved_dot_old && solutionUDotOld())
    _saved_dot_old = &addVector("save_solution_dot_old", false, PARALLEL);
  if (!_saved_dotdot_old && solutionUDotDotOld())
    _saved_dotdot_old = &addVector("save_solution_dotdot_old", false, PARALLEL);
 
  if (solutionUDotOld())
    *_saved_dot_old = *solutionUDotOld();
 
  if (solutionUDotDotOld())
    *_saved_dotdot_old = *solutionUDotDotOld();
}

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

  {
    return _undisplaced_system.serializedSolution();
  }

◆ 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 1643 of file SystemBase.C.

{
  _vars[tid].setActiveScalarVariableCoupleableVectorTags(vtags);
}

Referenced by SubProblem::setActiveScalarVariableCoupleableVectorTags().

◆ setActiveVariableCoupleableVectorTags()

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

inherited

Set the active vector tags for the variables.

Definition at line 1637 of file SystemBase.C.

{
  _vars[tid].setActiveVariableCoupleableVectorTags(vtags);
}

Referenced by SubProblem::setActiveFEVariableCoupleableVectorTags().

◆ setVariableGlobalDoFs()

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

inherited

set all the global dof indices for a variable

Parameters

var_name The name of the variable

Definition at line 188 of file SystemBase.C.

{
  AllLocalDofIndicesThread aldit(_subproblem, {var_name});
  const ConstElemRange & elem_range = *_mesh.getActiveLocalElementRange();
  Threads::parallel_reduce(elem_range, aldit, numThreads());
 
  // Gather the dof indices across procs to get all the dof indices for var_name
  aldit.dofIndicesSetUnion();
 
  const auto & all_dof_indices = aldit.getDofIndices();
  _var_all_dof_indices.assign(all_dof_indices.begin(), all_dof_indices.end());
}

◆ setVerboseFlag()

void SystemBase::setVerboseFlag ( const bool & verbose )

inlineinherited

Sets the verbose flag.

Parameters

[in] verbose Verbose flag

Definition at line 138 of file SystemBase.h.

138{ _verbose = verbose; }

Referenced by Executioner::Executioner().

◆ sizeVariableMatrixData()

void SystemBase::sizeVariableMatrixData ( )

inherited

size the matrix data for each variable for the number of matrix tags we have

Definition at line 1736 of file SystemBase.C.

{
  for (const auto & warehouse : _vars)
    for (const auto & [var_num, var_ptr] : warehouse.numberToVariableMap())
      var_ptr->sizeMatrixTagData();
}

◆ skipNextSolutionToOldCopy()

void SystemBase::skipNextSolutionToOldCopy ( )

inlineinherited

Skip the next copy from the solution vector to the old solution vector old -> older is still performed.

Definition at line 1003 of file SystemBase.h.

1003{ _skip_next_solution_to_old_copy = true; }

◆ solution() [1/2]

NumericVector< Number > & SystemBase::solution ( )

inlineinherited

Definition at line 215 of file SystemBase.h.

215{ return solutionState(0); }

◆ solution() [2/2]

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

inlineinherited

Definition at line 218 of file SystemBase.h.

218{ return solutionState(0); }

◆ solutionInternal()

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

inlineoverrideprotectedvirtual

Internal getter for solution owned by libMesh.

Implements SystemBase.

Definition at line 253 of file DisplacedSystem.h.

  {
    return _undisplaced_system.solution();
  }

◆ solutionOld() [1/2]

NumericVector< Number > & SystemBase::solutionOld ( )

inlineinherited

Definition at line 216 of file SystemBase.h.

216{ return solutionState(1); }

Referenced by MooseEigenSystem::combineSystemSolution(), CentralDifference::computeTimeDerivatives(), NonlinearSystemBase::constraintResiduals(), ActivateElementsUserObjectBase::initSolutions(), MooseEigenSystem::initSystemSolutionOld(), MooseVariableScalar::reinit(), Transient::relativeSolutionDifferenceNorm(), SystemBase::restoreSolutions(), ElementSubdomainModifierBase::setOldAndOlderSolutions(), ActuallyExplicitEuler::solve(), AdamsPredictor::timestepSetup(), and AuxiliarySystem::variableWiseRelativeSolutionDifferenceNorm().

◆ solutionOld() [2/2]

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

inlineinherited

Definition at line 219 of file SystemBase.h.

219{ return solutionState(1); }

◆ solutionOlder() [1/2]

NumericVector< Number > & SystemBase::solutionOlder ( )

inlineinherited

Definition at line 217 of file SystemBase.h.

217{ return solutionState(2); }

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

◆ solutionOlder() [2/2]

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

inlineinherited

Definition at line 220 of file SystemBase.h.

220{ return solutionState(2); }

◆ solutionPreviousNewton() [1/2]

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

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 117 of file DisplacedSystem.h.

117{ return nullptr; }

◆ solutionPreviousNewton() [2/2]

NumericVector< Number > * DisplacedSystem::solutionPreviousNewton ( )

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 116 of file DisplacedSystem.h.

116{ return nullptr; }

◆ solutionState() [1/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 276 of file DisplacedSystem.h.

{
  return _undisplaced_system.solutionState(state, iteration_type);
}

◆ solutionState() [2/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 269 of file DisplacedSystem.h.

{
  return _undisplaced_system.solutionState(state, iteration_type);
}

◆ solutionStateParallelType()

libMesh::ParallelType SystemBase::solutionStateParallelType	(	const unsigned int	state,
		const Moose::SolutionIterationType	iteration_type
	)		const

inherited

Returns the parallel type of the given solution state.

Definition at line 1478 of file SystemBase.C.

{
  if (!hasSolutionState(state, iteration_type))
    mooseError("solutionStateParallelType() may only be called if the solution state exists.");
  return getSolutionStates(iteration_type)[state]->type();
}

Referenced by SolverSystem::applyFixedPointRelaxation(), and SystemBase::needSolutionState().

◆ 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 929 of file SystemBase.h.

929{ return _solution_states_initialized; }

SystemBase::_solution_states_initialized

bool _solution_states_initialized

Whether or not the solution states have been initialized.

Definition SystemBase.h:1106

Referenced by LinearFVGradientManager::computeGradientsForMethods(), LinearFVGradientManager::resizeGradientStateStorage(), AuxScalarKernel::uOld(), and ScalarKernelBase::uOld().

◆ solutionUDot() [1/2]

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

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 132 of file DisplacedSystem.h.

  {
    return _undisplaced_system.solutionUDot();
  }

◆ solutionUDot() [2/2]

NumericVector< Number > * DisplacedSystem::solutionUDot ( )

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 119 of file DisplacedSystem.h.

119{ return _undisplaced_system.solutionUDot(); }

◆ solutionUDotDot() [1/2]

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

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 136 of file DisplacedSystem.h.

  {
    return _undisplaced_system.solutionUDotDot();
  }

◆ solutionUDotDot() [2/2]

NumericVector< Number > * DisplacedSystem::solutionUDotDot ( )

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 120 of file DisplacedSystem.h.

  {
    return _undisplaced_system.solutionUDotDot();
  }

◆ solutionUDotDotOld() [1/2]

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

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 144 of file DisplacedSystem.h.

  {
    return _undisplaced_system.solutionUDotDotOld();
  }

◆ solutionUDotDotOld() [2/2]

NumericVector< Number > * DisplacedSystem::solutionUDotDotOld ( )

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 128 of file DisplacedSystem.h.

  {
    return _undisplaced_system.solutionUDotDotOld();
  }

◆ solutionUDotOld() [1/2]

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

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 140 of file DisplacedSystem.h.

  {
    return _undisplaced_system.solutionUDotOld();
  }

◆ solutionUDotOld() [2/2]

NumericVector< Number > * DisplacedSystem::solutionUDotOld ( )

inlineoverridevirtual

Reimplemented from SystemBase.

Definition at line 124 of file DisplacedSystem.h.

  {
    return _undisplaced_system.solutionUDotOld();
  }

◆ solve()

void SystemBase::solve ( )

virtualinherited

Solve the system (using libMesh magic)

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

Definition at line 1249 of file SystemBase.C.

{
  system().solve();
}

◆ subdomainSetup()

void SystemBase::subdomainSetup ( )

virtualinherited

Reimplemented in NonlinearSystemBase, and AuxiliarySystem.

Definition at line 1609 of file SystemBase.C.

{
  for (THREAD_ID tid = 0; tid < numThreads(); tid++)
    _vars[tid].subdomainSetup();
}

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

◆ subproblem() [1/2]

SubProblem & SystemBase::subproblem ( )

inlineinherited

Definition at line 102 of file SystemBase.h.

102{ return _subproblem; }

Referenced by CreateDisplacedProblemAction::addProxyRelationshipManagers(), MooseVariableBase::allDofIndices(), NonlinearSystemBase::constraintJacobians(), NonlinearSystemBase::constraintResiduals(), Moose::globalDofIndexToDerivative(), NonlinearSystemBase::initialSetup(), MooseVariableScalar::MooseVariableScalar(), NonlinearSystemBase::overwriteNodeFace(), MooseVariableScalar::reinit(), NonlinearSystemBase::reinitNodeFace(), NonlinearSystemBase::setConstraintSecondaryValues(), and MooseVariableScalar::sizeMatrixTagData().

◆ subproblem() [2/2]

const SubProblem & SystemBase::subproblem ( ) const

inlineinherited

Definition at line 103 of file SystemBase.h.

103{ return _subproblem; }

◆ sys()

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

inlinevirtual

Definition at line 245 of file DisplacedSystem.h.

245{ return _sys; }

◆ system() [1/2]

const System & DisplacedSystem::system ( ) const

overridevirtual

Implements SystemBase.

Definition at line 62 of file DisplacedSystem.C.

{
  return _sys;
}

◆ system() [2/2]

System & DisplacedSystem::system ( )

overridevirtual

Get the reference to the libMesh system.

Implements SystemBase.

Definition at line 56 of file DisplacedSystem.C.

{
  return _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.

48{ return _undisplaced_system.systemMatrixTag(); }

SystemBase::systemMatrixTag

virtual TagID systemMatrixTag() const

Return the Matrix Tag ID for System.

Definition SystemBase.h:328

◆ timestepSetup()

void SystemBase::timestepSetup ( )

virtualinherited

Reimplemented in AuxiliarySystem, and NonlinearSystemBase.

Definition at line 1595 of file SystemBase.C.

{
  for (THREAD_ID tid = 0; tid < numThreads(); tid++)
    _vars[tid].timestepSetup();
}

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

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

50{ return _undisplaced_system.timeVectorTag(); }

SystemBase::timeVectorTag

virtual TagID timeVectorTag() const

Ideally, we should not need this API.

Definition SystemBase.h:323

◆ update()

void SystemBase::update ( )

inherited

Update the system (doing libMesh magic)

Definition at line 1243 of file SystemBase.C.

{
  system().update();
}

Referenced by Adaptivity::adaptMesh(), SolverSystem::applyFixedPointRelaxation(), MooseEigenSystem::combineSystemSolution(), NonlinearSystemBase::computeDamping(), NonlinearSystemBase::computeJacobianInternal(), NonlinearSystemBase::computeResidualTags(), EigenProblem::doFreeNonlinearPowerIterations(), FunctorNodalCorrector::finalize(), PointwiseRenormalizeVector::finalize(), MooseEigenSystem::initSystemSolution(), MooseEigenSystem::initSystemSolutionOld(), MooseEigenSystem::scaleSystemSolution(), NonlinearSystemBase::setConstraintSecondaryValues(), NonlinearSystemBase::setInitialSolution(), FEProblemBase::solve(), EigenProblem::solve(), DisplacedProblem::syncSolutions(), MultiAppDofCopyTransfer::transfer(), PicardSolve::transformVariables(), SecantSolve::transformVariables(), and SteffensenSolve::transformVariables().

◆ variableWarehouse()

const VariableWarehouse & SystemBase::variableWarehouse ( THREAD_ID tid = 0 ) const

inlineinherited

Definition at line 787 of file SystemBase.h.

787{ return _vars[tid]; }

Referenced by NonlinearSystemBase::checkKernelCoverage(), and AuxiliarySystem::updateFVGradient().

◆ varKind()

Moose::VarKindType SystemBase::varKind ( ) const

inlineinherited

Returns: the type of variables this system holds, e.g. nonlinear or auxiliary

Definition at line 957 of file SystemBase.h.

957{ return _var_kind; }

SystemBase::_var_kind

Moose::VarKindType _var_kind

default kind of variables in this system

Definition SystemBase.h:1083

Referenced by Coupleable::coupled().

◆ zeroTaggedVector()

void SystemBase::zeroTaggedVector ( const TagID tag )

inherited

Zero vector with the given tag.

Definition at line 676 of file SystemBase.C.

{
  if (!_subproblem.vectorTagExists(tag))
    mooseError("Cannot zero vector with TagID ",
               tag,
               " in system '",
               name(),
               "' because that tag does not exist in the problem");
  else if (!hasVector(tag))
    mooseError("Cannot zero vector tag with name '",
               _subproblem.vectorTagName(tag),
               "' in system '",
               name(),
               "' because there is no vector associated with that tag");
  if (!_subproblem.vectorTagNotZeroed(tag))
    getVector(tag).zero();
}

Referenced by SystemBase::zeroTaggedVectors().

◆ zeroTaggedVectors()

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

inherited

Zero all vectors for given tags.

Definition at line 695 of file SystemBase.C.

{
  for (const auto tag : tags)
    zeroTaggedVector(tag);
}

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

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

  {
    _undisplaced_system.zeroVariables(vars_to_be_zeroed);
  }

◆ 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 237 of file SystemBase.C.

{
  zeroVariables(_vars_to_be_zeroed_on_jacobian);
}

◆ 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 231 of file SystemBase.C.

{
  zeroVariables(_vars_to_be_zeroed_on_residual);
}

Member Data Documentation

◆ _active_tagged_matrices

std::unordered_map<TagID, libMesh::SparseMatrix<Number> *> SystemBase::_active_tagged_matrices

protectedinherited

Active tagged matrices. A matrix is active if its tag-matrix pair is present in the map. We use a map instead of a vector so that users can easily add and remove to this container with calls to (de)activateMatrixTag.

Definition at line 1070 of file SystemBase.h.

Referenced by SystemBase::activateAllMatrixTags(), SystemBase::deactivateAllMatrixTags(), and SystemBase::reinitElem().

◆ _app

MooseApp& SystemBase::_app

protectedinherited

Definition at line 1033 of file SystemBase.h.

Referenced by SolverSystem::checkInvalidSolution(), NonlinearSystemBase::computeJacobianBlocks(), NonlinearSystemBase::computeJacobianInternal(), NonlinearSystemBase::computeJacobianTags(), LinearSystem::computeLinearSystemInternal(), LinearSystem::computeLinearSystemTags(), NonlinearSystemBase::computeResidualInternal(), NonlinearSystemBase::computeResidualTags(), NonlinearSystem::converged(), SystemBase::numThreads(), and NonlinearSystemBase::shouldEvaluatePreSMOResidual().

◆ _automatic_scaling

bool SystemBase::_automatic_scaling

protectedinherited

Whether to automatically scale the variables.

Definition at line 1100 of file SystemBase.h.

Referenced by SystemBase::automaticScaling(), 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.

◆ _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 1062 of file SystemBase.h.

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

◆ _du_dotdot_du

Real SystemBase::_du_dotdot_du

protectedinherited

Definition at line 1063 of file SystemBase.h.

Referenced by SystemBase::duDotDotDu(), and SystemBase::duDotDotDu().

◆ _factory

Factory& SystemBase::_factory

protectedinherited

Definition at line 1034 of file SystemBase.h.

◆ _fe_problem

FEProblemBase& SystemBase::_fe_problem

protectedinherited

the governing finite element/volume problem

Definition at line 1031 of file SystemBase.h.

◆ _matrix_tag_active_flags

std::vector<bool> SystemBase::_matrix_tag_active_flags

protectedinherited

Active flags for tagged matrices.

Definition at line 1072 of file SystemBase.h.

Referenced by SystemBase::activateAllMatrixTags(), SystemBase::deactivateAllMatrixTags(), and SystemBase::matrixTagActive().

◆ _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 1088 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 1091 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 1045 of file SystemBase.h.

Referenced by SystemBase::getMaxVariableNumber().

◆ _mesh

MooseMesh& SystemBase::_mesh

protectedinherited

◆ _name

std::string SystemBase::_name

protectedinherited

The name of this system.

Definition at line 1038 of file SystemBase.h.

◆ _numbered_vars

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

protectedinherited

Map variable number to its pointer.

Definition at line 1097 of file SystemBase.h.

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

◆ _saved_dot_old

NumericVector<Real>* SystemBase::_saved_dot_old

protectedinherited

Definition at line 1079 of file SystemBase.h.

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

◆ _saved_dotdot_old

NumericVector<Real>* SystemBase::_saved_dotdot_old

protectedinherited

Definition at line 1080 of file SystemBase.h.

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

◆ _saved_old

NumericVector<Real>* SystemBase::_saved_old

protectedinherited

Definition at line 1075 of file SystemBase.h.

◆ _saved_older

NumericVector<Real>* SystemBase::_saved_older

protectedinherited

Definition at line 1076 of file SystemBase.h.

◆ _saved_solution_states

std::vector<NumericVector<Number> *> SystemBase::_saved_solution_states

privateinherited

The saved solution states (0 = current, 1 = old, 2 = older, etc)

Definition at line 1145 of file SystemBase.h.

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

◆ _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 1113 of file SystemBase.h.

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

◆ _skip_next_solution_to_old_copy

bool SystemBase::_skip_next_solution_to_old_copy

privateinherited

Whether to skip the next copy from the solution to the old vector.

Definition at line 1147 of file SystemBase.h.

Referenced by SystemBase::advanceStateHistory(), SystemBase::copyPreviousSolutions(), and SystemBase::skipNextSolutionToOldCopy().

◆ _solution_states

std::array<std::vector<NumericVector<Number> *>, static_cast<size_t>(Moose::SolutionIterationType::Count)> SystemBase::_solution_states

privateinherited

2D array of solution state vector pointers.

Outer (array) index: SolutionIterationType (Time, Nonlinear, ...) Inner (vector) index: State (0=current, 1=old, ...)

Should only be accessed through getSolutionStates() when possible for bounds checking.

Definition at line 1143 of file SystemBase.h.

Referenced by SystemBase::getSolutionStates().

◆ _solution_states_initialized

bool SystemBase::_solution_states_initialized

protectedinherited

Whether or not the solution states have been initialized.

Definition at line 1106 of file SystemBase.h.

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

◆ _subproblem

SubProblem& SystemBase::_subproblem

protectedinherited

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.

Definition at line 1028 of file SystemBase.h.

Referenced by SystemBase::activateAllMatrixTags(), SystemBase::addMatrix(), SystemBase::addVector(), SystemBase::associateMatrixToTag(), SystemBase::associateVectorToTag(), SystemBase::augmentSendList(), SystemBase::closeTaggedVector(), SystemBase::computingScalingJacobian(), SystemBase::deactivateAllMatrixTags(), SystemBase::disassociateDefaultMatrixTags(), SystemBase::disassociateDefaultVectorTags(), SystemBase::disassociateMatrixFromTag(), SystemBase::disassociateMatrixFromTag(), SystemBase::disassociateVectorFromTag(), SystemBase::disassociateVectorFromTag(), SystemBase::getMatrix(), SystemBase::getMatrix(), NonlinearSystemBase::getResidualNonTimeVector(), NonlinearSystemBase::getResidualTimeVector(), SystemBase::getVector(), SystemBase::getVector(), SystemBase::matrixTagActive(), SystemBase::needSolutionState(), SystemBase::prepare(), SystemBase::prepareFace(), SystemBase::reinitElem(), SystemBase::removeMatrix(), SystemBase::removeVector(), NonlinearSystemBase::residualGhosted(), SolverSystem::setSolution(), SystemBase::setVariableGlobalDoFs(), SystemBase::subproblem(), SystemBase::subproblem(), SystemBase::zeroTaggedVector(), and SystemBase::zeroVariables().

◆ _sys

libMesh::System& DisplacedSystem::_sys

protected

Definition at line 259 of file DisplacedSystem.h.

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

◆ _tagged_matrices

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

protectedinherited

Tagged matrices (pointer)

Definition at line 1068 of file SystemBase.h.

Referenced by SystemBase::associateMatrixToTag(), SystemBase::disassociateMatrixFromTag(), SystemBase::getMatrix(), SystemBase::getMatrix(), SystemBase::hasMatrix(), and SystemBase::removeMatrix().

◆ _tagged_vectors

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

protectedinherited

Tagged vectors (pointer)

Definition at line 1066 of file SystemBase.h.

Referenced by SystemBase::associateVectorToTag(), SystemBase::disassociateVectorFromTag(), SystemBase::getVector(), SystemBase::getVector(), SystemBase::hasVector(), and SystemBase::removeVector().

◆ _time_integrators

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

protectedinherited

Time integrator.

Definition at line 1094 of file SystemBase.h.

Referenced by SystemBase::addTimeIntegrator(), AuxiliarySystem::compute(), LinearSystem::compute(), SolverSystem::compute(), NonlinearSystemBase::computeResidualAndJacobianTags(), NonlinearSystemBase::computeResidualTags(), SystemBase::copyTimeIntegrators(), SystemBase::getTimeIntegrators(), NonlinearEigenSystem::nLinearIterations(), NonlinearEigenSystem::nNonlinearIterations(), NonlinearSystemBase::onTimestepBegin(), SystemBase::queryTimeIntegrator(), NonlinearEigenSystem::solve(), and NonlinearSystem::solve().

◆ _u_dot

NumericVector<Number>* SystemBase::_u_dot

protectedinherited

solution vector for u^dot

Definition at line 1051 of file SystemBase.h.

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

◆ _u_dot_old

NumericVector<Number>* SystemBase::_u_dot_old

protectedinherited

old solution vector for u^dot

Definition at line 1056 of file SystemBase.h.

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

◆ _u_dotdot

NumericVector<Number>* SystemBase::_u_dotdot

protectedinherited

solution vector for u^dotdot

Definition at line 1053 of file SystemBase.h.

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

◆ _u_dotdot_old

NumericVector<Number>* SystemBase::_u_dotdot_old

protectedinherited

old solution vector for u^dotdot

Definition at line 1058 of file SystemBase.h.

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

◆ _undisplaced_system

SystemBase& DisplacedSystem::_undisplaced_system

protected

Definition at line 258 of file DisplacedSystem.h.

Referenced by addDotVectors(), addVariableToZeroOnJacobian(), addVariableToZeroOnResidual(), associateMatrixToTag(), associateVectorToTag(), augmentSendList(), currentSolution(), defaultMatrixTags(), defaultVectorTags(), disassociateDefaultMatrixTags(), disassociateDefaultVectorTags(), disassociateMatrixFromTag(), disassociateMatrixFromTag(), disassociateVectorFromTag(), disassociateVectorFromTag(), duDotDotDu(), duDotDotDu(), duDotDu(), duDotDus(), getMatrix(), getMatrix(), getVector(), getVector(), getVector(), getVector(), hasMatrix(), hasSolutionState(), hasVector(), initSolutionState(), needSolutionState(), nonTimeVectorTag(), residualCopy(), residualGhosted(), residualVectorTag(), serializedSolution(), solutionInternal(), solutionState(), solutionState(), solutionUDot(), solutionUDot(), solutionUDotDot(), solutionUDotDot(), solutionUDotDotOld(), solutionUDotDotOld(), solutionUDotOld(), solutionUDotOld(), systemMatrixTag(), timeVectorTag(), and zeroVariables().

◆ _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 1109 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 1083 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 1043 of file SystemBase.h.

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

◆ _var_to_copy

std::vector<VarCopyInfo> SystemBase::_var_to_copy

protectedinherited

Definition at line 1085 of file SystemBase.h.

Referenced by SystemBase::addVariableToCopy(), SystemBase::copyVars(), and SystemBase::hasVarCopy().

◆ _vars

std::vector<VariableWarehouse> SystemBase::_vars

protectedinherited

Variable warehouses (one for each thread)

Definition at line 1041 of file SystemBase.h.

◆ _vars_to_be_zeroed_on_jacobian

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

protectedinherited

Definition at line 1048 of file SystemBase.h.

Referenced by SystemBase::addVariableToZeroOnJacobian(), and SystemBase::zeroVariablesForJacobian().

◆ _vars_to_be_zeroed_on_residual

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

protectedinherited

Definition at line 1047 of file SystemBase.h.

Referenced by SystemBase::addVariableToZeroOnResidual(), and SystemBase::zeroVariablesForResidual().

◆ _verbose

bool SystemBase::_verbose

protectedinherited

True if printing out additional information.

Definition at line 1103 of file SystemBase.h.

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

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

include/systems/DisplacedSystem.h
src/systems/DisplacedSystem.C

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DisplacedSystem() [1/2]

◆ DisplacedSystem() [2/2]

◆ ~DisplacedSystem()

Member Function Documentation

◆ activateAllMatrixTags()

◆ addDotVectors()

◆ addMatrix()

◆ addTimeIntegrator()

◆ addVariable()

◆ addVariableToCopy()

◆ addVariableToZeroOnJacobian()

◆ addVariableToZeroOnResidual()

◆ addVector() [1/2]

◆ addVector() [2/2]

◆ advanceStateHistory()

◆ applyScalingFactors()

◆ assignMaxVarNDofsPerElem()

◆ assignMaxVarNDofsPerNode()

◆ associateMatrixToTag()

◆ associateVectorToTag()

◆ augmentSendList()

◆ augmentSparsity()

◆ automaticScaling() [1/2]

◆ automaticScaling() [2/2]

◆ clearAllDofIndices()

◆ closeTaggedMatrices()

◆ closeTaggedVector()

◆ closeTaggedVectors()

◆ compute()

◆ computeVariables()

◆ computingScalingJacobian()

◆ copyAdditionalStateBackwards()

◆ copyOldSolutions()

◆ copyPreviousSolutions()

◆ copySolutionsBackwards()

◆ copyStateHistoryBackwards()

◆ copyTimeIntegrators()

◆ copyVars()

◆ currentSolution()

◆ customSetup()

◆ deactivateAllMatrixTags()

◆ defaultMatrixTags()

◆ defaultVectorTags()

◆ disassociateDefaultMatrixTags()

◆ disassociateDefaultVectorTags()

◆ disassociateMatrixFromTag() [1/2]

◆ disassociateMatrixFromTag() [2/2]

◆ disassociateVectorFromTag() [1/2]

◆ disassociateVectorFromTag() [2/2]

◆ dofMap() [1/2]

◆ dofMap() [2/2]

◆ duDotDotDu() [1/2]

◆ duDotDotDu() [2/2]

◆ duDotDu()

◆ duDotDus()

◆ feProblem() [1/2]

◆ feProblem() [2/2]

◆ flushTaggedMatrices()

◆ getActualFieldVariable() [1/2]

◆ getActualFieldVariable() [2/2]

◆ getFieldVariable() [1/2]

◆ getFieldVariable() [2/2]

◆ getFVVariable()

◆ getMatrix() [1/2]

◆ getMatrix() [2/2]

◆ getMaxVariableNumber()

◆ getMaxVarNDofsPerElem()

◆ getMaxVarNDofsPerNode()

◆ getMinQuadratureOrder()

◆ getNumSolutionStates()

◆ getScalarVariable() [1/2]

◆ getScalarVariable() [2/2]