A problem that handles Schur complement preconditioning of the incompressible Navier-Stokes equations. More...

#include <NavierStokesProblem.h>

Inheritance diagram for NavierStokesProblem:

Public Types
enum	CoverageCheckMode { CoverageCheckMode::FALSE, CoverageCheckMode::TRUE, CoverageCheckMode::OFF, CoverageCheckMode::ON, CoverageCheckMode::SKIP_LIST, CoverageCheckMode::ONLY_LIST }

typedef DataFileName	DataFileParameterType

Public Member Functions
	NavierStokesProblem (const InputParameters &parameters)

TagID	massMatrixTagID () const

TagID	LMatrixTagID () const

void	clearIndexSets ()
	Clear the field split index sets. More...

KSP	findSchurKSP (KSP node, unsigned int tree_position)

void	setupLSCMatrices (KSP schur_ksp)
	Setup the Least Squares Commutator (LSC) preconditioner given the Schur complement `KSP` object. More...

virtual	~NavierStokesProblem ()
	Will destroy any matrices we allocated. More...

virtual bool	getUseNonlinear () const

virtual void	setUseNonlinear (bool use_nonlinear)

virtual void	setInputParametersFEProblem (InputParameters &parameters) override

virtual NonlinearSystem &	getNonlinearSystem (const unsigned int nl_sys_num) override

virtual void	addLineSearch (const InputParameters &parameters) override

virtual void	init () override

virtual libMesh::EquationSystems &	es () override

virtual MooseMesh &	mesh () override

virtual const MooseMesh &	mesh () const override

const MooseMesh &	mesh (bool use_displaced) const override

void	setCoordSystem (const std::vector< SubdomainName > &blocks, const MultiMooseEnum &coord_sys)

void	setAxisymmetricCoordAxis (const MooseEnum &rz_coord_axis)

void	setCoupling (Moose::CouplingType type)

Moose::CouplingType	coupling () const

void	setCouplingMatrix (std::unique_ptr< libMesh::CouplingMatrix > cm, const unsigned int nl_sys_num)

void	setCouplingMatrix (libMesh::CouplingMatrix *cm, const unsigned int nl_sys_num)

const libMesh::CouplingMatrix *	couplingMatrix (const unsigned int nl_sys_num) const override

void	setNonlocalCouplingMatrix ()

bool	areCoupled (const unsigned int ivar, const unsigned int jvar, const unsigned int nl_sys_num) const

bool	hasUOAuxStateCheck () const

bool	checkingUOAuxState () const

void	trustUserCouplingMatrix ()

std::vector< std::pair< MooseVariableFEBase , MooseVariableFEBase > > &	couplingEntries (const THREAD_ID tid, const unsigned int nl_sys_num)

std::vector< std::pair< MooseVariableFEBase , MooseVariableFEBase > > &	nonlocalCouplingEntries (const THREAD_ID tid, const unsigned int nl_sys_num)

virtual bool	hasVariable (const std::string &var_name) const override

bool	hasSolverVariable (const std::string &var_name) const

virtual const MooseVariableFieldBase &	getVariable (const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const override

virtual const MooseVariableFieldBase &	getVariable (const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const =0

virtual MooseVariableFieldBase &	getVariable (const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY)

virtual MooseVariableFieldBase &	getVariable (const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY)

MooseVariableFieldBase &	getActualFieldVariable (const THREAD_ID tid, const std::string &var_name) override

virtual MooseVariable &	getStandardVariable (const THREAD_ID tid, const std::string &var_name) override

virtual VectorMooseVariable &	getVectorVariable (const THREAD_ID tid, const std::string &var_name) override

virtual ArrayMooseVariable &	getArrayVariable (const THREAD_ID tid, const std::string &var_name) override

virtual bool	hasScalarVariable (const std::string &var_name) const override

virtual MooseVariableScalar &	getScalarVariable (const THREAD_ID tid, const std::string &var_name) override

virtual libMesh::System &	getSystem (const std::string &var_name) override

virtual void	setActiveElementalMooseVariables (const std::set< MooseVariableFEBase * > &moose_vars, const THREAD_ID tid) override

virtual void	clearActiveElementalMooseVariables (const THREAD_ID tid) override

virtual void	clearActiveFEVariableCoupleableMatrixTags (const THREAD_ID tid) override

virtual void	clearActiveFEVariableCoupleableVectorTags (const THREAD_ID tid) override

virtual void	setActiveFEVariableCoupleableVectorTags (std::set< TagID > &vtags, const THREAD_ID tid) override

virtual void	setActiveFEVariableCoupleableMatrixTags (std::set< TagID > &mtags, const THREAD_ID tid) override

virtual void	clearActiveScalarVariableCoupleableMatrixTags (const THREAD_ID tid) override

virtual void	clearActiveScalarVariableCoupleableVectorTags (const THREAD_ID tid) override

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

virtual void	setActiveScalarVariableCoupleableMatrixTags (std::set< TagID > &mtags, const THREAD_ID tid) override

virtual void	createQRules (libMesh::QuadratureType type, libMesh::Order order, libMesh::Order volume_order=libMesh::INVALID_ORDER, libMesh::Order face_order=libMesh::INVALID_ORDER, SubdomainID block=Moose::ANY_BLOCK_ID, bool allow_negative_qweights=true)

void	bumpVolumeQRuleOrder (libMesh::Order order, SubdomainID block)

void	bumpAllQRuleOrder (libMesh::Order order, SubdomainID block)

unsigned int	getMaxQps () const

libMesh::Order	getMaxScalarOrder () const

void	checkNonlocalCoupling ()

void	checkUserObjectJacobianRequirement (THREAD_ID tid)

void	setVariableAllDoFMap (const std::vector< const MooseVariableFEBase * > &moose_vars)

const std::vector< const MooseVariableFEBase *> &	getUserObjectJacobianVariables (const THREAD_ID tid) const

virtual Assembly &	assembly (const THREAD_ID tid, const unsigned int sys_num) override

virtual const Assembly &	assembly (const THREAD_ID tid, const unsigned int sys_num) const override

virtual std::vector< VariableName >	getVariableNames ()

void	initialSetup () override

void	checkDuplicatePostprocessorVariableNames ()

void	timestepSetup () override

void	customSetup (const ExecFlagType &exec_type) override

void	residualSetup () override

void	jacobianSetup () override

virtual void	prepare (const Elem *elem, const THREAD_ID tid) override

virtual void	prepare (const Elem *elem, unsigned int ivar, unsigned int jvar, const std::vector< dof_id_type > &dof_indices, const THREAD_ID tid) override

virtual void	prepareFace (const Elem *elem, const THREAD_ID tid) override

virtual void	setCurrentSubdomainID (const Elem *elem, const THREAD_ID tid) override

virtual void	setNeighborSubdomainID (const Elem *elem, unsigned int side, const THREAD_ID tid) override

virtual void	setNeighborSubdomainID (const Elem *elem, const THREAD_ID tid)

virtual void	prepareAssembly (const THREAD_ID tid) override

virtual void	addGhostedElem (dof_id_type elem_id) override

virtual void	addGhostedBoundary (BoundaryID boundary_id) override

virtual void	ghostGhostedBoundaries () override

virtual void	sizeZeroes (unsigned int size, const THREAD_ID tid)

virtual bool	reinitDirac (const Elem *elem, const THREAD_ID tid) override

virtual void	reinitElem (const Elem *elem, const THREAD_ID tid) override

virtual void	reinitElemPhys (const Elem *elem, const std::vector< Point > &phys_points_in_elem, const THREAD_ID tid) override

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

virtual void	reinitElemFace (const Elem *elem, unsigned int side, const THREAD_ID tid) override

virtual void	reinitLowerDElem (const Elem lower_d_elem, const THREAD_ID tid, const std::vector< Point > const pts=nullptr, const std::vector< Real > *const weights=nullptr) override

virtual void	reinitNode (const Node *node, const THREAD_ID tid) override

virtual void	reinitNodeFace (const Node *node, BoundaryID bnd_id, const THREAD_ID tid) override

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

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

virtual void	reinitNeighbor (const Elem *elem, unsigned int side, const THREAD_ID tid) override

virtual void	reinitNeighborPhys (const Elem *neighbor, unsigned int neighbor_side, const std::vector< Point > &physical_points, const THREAD_ID tid) override

virtual void	reinitNeighborPhys (const Elem *neighbor, const std::vector< Point > &physical_points, const THREAD_ID tid) override

virtual void	reinitElemNeighborAndLowerD (const Elem *elem, unsigned int side, const THREAD_ID tid) override

virtual void	reinitScalars (const THREAD_ID tid, bool reinit_for_derivative_reordering=false) override

virtual void	reinitOffDiagScalars (const THREAD_ID tid) override

virtual void	getDiracElements (std::set< const Elem * > &elems) override

virtual void	clearDiracInfo () override

virtual void	subdomainSetup (SubdomainID subdomain, const THREAD_ID tid)

virtual void	neighborSubdomainSetup (SubdomainID subdomain, const THREAD_ID tid)

virtual void	newAssemblyArray (std::vector< std::shared_ptr< SolverSystem >> &solver_systems)

virtual void	initNullSpaceVectors (const InputParameters &parameters, std::vector< std::shared_ptr< NonlinearSystemBase >> &nl)

virtual void	solve (const unsigned int nl_sys_num)

virtual void	solveLinearSystem (const unsigned int linear_sys_num, const Moose::PetscSupport::PetscOptions *po=nullptr)

virtual void	setException (const std::string &message)

virtual bool	hasException ()

virtual void	checkExceptionAndStopSolve (bool print_message=true)

virtual bool	solverSystemConverged (const unsigned int solver_sys_num) override

virtual unsigned int	nNonlinearIterations (const unsigned int nl_sys_num) const override

virtual unsigned int	nLinearIterations (const unsigned int nl_sys_num) const override

virtual Real	finalNonlinearResidual (const unsigned int nl_sys_num) const override

virtual bool	computingPreSMOResidual (const unsigned int nl_sys_num) const override

virtual std::string	solverTypeString (unsigned int solver_sys_num=0)

virtual bool	startedInitialSetup ()

virtual void	onTimestepBegin () override

virtual void	onTimestepEnd () override

virtual Real &	time () const

virtual Real &	timeOld () const

virtual int &	timeStep () const

virtual Real &	dt () const

virtual Real &	dtOld () const

Real	getTimeFromStateArg (const Moose::StateArg &state) const

virtual void	transient (bool trans)

virtual bool	isTransient () const override

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

virtual void	addPredictor (const std::string &type, const std::string &name, InputParameters &parameters)

virtual void	copySolutionsBackwards ()

virtual void	advanceState ()

virtual void	restoreSolutions ()

virtual void	saveOldSolutions ()

virtual void	restoreOldSolutions ()

void	needSolutionState (unsigned int oldest_needed, Moose::SolutionIterationType iteration_type)

virtual void	outputStep (ExecFlagType type)

virtual void	postExecute ()

void	forceOutput ()

Moose::PetscSupport::PetscOptions &	getPetscOptions ()

void	logAdd (const std::string &system, const std::string &name, const std::string &type, const InputParameters &params) const

virtual void	addFunction (const std::string &type, const std::string &name, InputParameters &parameters)

virtual bool	hasFunction (const std::string &name, const THREAD_ID tid=0)

virtual Function &	getFunction (const std::string &name, const THREAD_ID tid=0)

virtual void	addMeshDivision (const std::string &type, const std::string &name, InputParameters &params)

MeshDivision &	getMeshDivision (const std::string &name, const THREAD_ID tid=0) const

virtual void	addConvergence (const std::string &type, const std::string &name, InputParameters &parameters)

virtual Convergence &	getConvergence (const std::string &name, const THREAD_ID tid=0) const

virtual const std::vector< std::shared_ptr< Convergence > > &	getConvergenceObjects (const THREAD_ID tid=0) const

virtual bool	hasConvergence (const std::string &name, const THREAD_ID tid=0) const

bool	needToAddDefaultNonlinearConvergence () const

bool	needToAddDefaultMultiAppFixedPointConvergence () const

void	setNeedToAddDefaultNonlinearConvergence ()

void	setNeedToAddDefaultMultiAppFixedPointConvergence ()

bool	hasSetMultiAppFixedPointConvergenceName () const

virtual void	addDefaultNonlinearConvergence (const InputParameters &params)

virtual bool	onlyAllowDefaultNonlinearConvergence () const

void	addDefaultMultiAppFixedPointConvergence (const InputParameters &params)

virtual void	lineSearch ()

LineSearch *	getLineSearch () override

virtual void	addDistribution (const std::string &type, const std::string &name, InputParameters &parameters)

virtual Distribution &	getDistribution (const std::string &name)

virtual void	addSampler (const std::string &type, const std::string &name, InputParameters &parameters)

virtual Sampler &	getSampler (const std::string &name, const THREAD_ID tid=0)

NonlinearSystemBase &	getNonlinearSystemBase (const unsigned int sys_num)

const NonlinearSystemBase &	getNonlinearSystemBase (const unsigned int sys_num) const

void	setCurrentNonlinearSystem (const unsigned int nl_sys_num)

NonlinearSystemBase &	currentNonlinearSystem ()

const NonlinearSystemBase &	currentNonlinearSystem () const

virtual const SystemBase &	systemBaseNonlinear (const unsigned int sys_num) const override

virtual SystemBase &	systemBaseNonlinear (const unsigned int sys_num) override

virtual const SystemBase &	systemBaseSolver (const unsigned int sys_num) const override

virtual SystemBase &	systemBaseSolver (const unsigned int sys_num) override

virtual const SystemBase &	systemBaseAuxiliary () const override

virtual SystemBase &	systemBaseAuxiliary () override

virtual const SystemBase &	getSystemBase (const unsigned int sys_num) const

virtual SystemBase &	getSystemBase (const unsigned int sys_num)

LinearSystem &	getLinearSystem (unsigned int sys_num)

const LinearSystem &	getLinearSystem (unsigned int sys_num) const

SolverSystem &	getSolverSystem (unsigned int sys_num)

const SolverSystem &	getSolverSystem (unsigned int sys_num) const

void	setCurrentLinearSystem (unsigned int sys_num)

LinearSystem &	currentLinearSystem ()

const LinearSystem &	currentLinearSystem () const

virtual const SystemBase &	systemBaseLinear (unsigned int sys_num) const override

virtual SystemBase &	systemBaseLinear (unsigned int sys_num) override

virtual void	addVariable (const std::string &var_type, const std::string &var_name, InputParameters &params)

virtual void	addKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addHDGKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addNodalKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addScalarKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addBoundaryCondition (const std::string &bc_name, const std::string &name, InputParameters &parameters)

virtual void	addConstraint (const std::string &c_name, const std::string &name, InputParameters &parameters)

virtual void	addAuxVariable (const std::string &var_type, const std::string &var_name, InputParameters &params)

virtual void	addAuxVariable (const std::string &var_name, const libMesh::FEType &type, const std::set< SubdomainID > *const active_subdomains=NULL)

virtual void	addAuxArrayVariable (const std::string &var_name, const libMesh::FEType &type, unsigned int components, const std::set< SubdomainID > *const active_subdomains=NULL)

virtual void	addAuxScalarVariable (const std::string &var_name, libMesh::Order order, Real scale_factor=1., const std::set< SubdomainID > *const active_subdomains=NULL)

virtual void	addAuxKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addAuxScalarKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

AuxiliarySystem &	getAuxiliarySystem ()

virtual void	addDiracKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addDGKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addFVKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addLinearFVKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addFVBC (const std::string &fv_bc_name, const std::string &name, InputParameters &parameters)

virtual void	addLinearFVBC (const std::string &fv_bc_name, const std::string &name, InputParameters &parameters)

virtual void	addFVInterfaceKernel (const std::string &fv_ik_name, const std::string &name, InputParameters &parameters)

virtual void	addInterfaceKernel (const std::string &kernel_name, const std::string &name, InputParameters &parameters)

virtual void	addInitialCondition (const std::string &ic_name, const std::string &name, InputParameters &parameters)

virtual void	addFVInitialCondition (const std::string &ic_name, const std::string &name, InputParameters &parameters)

void	projectSolution ()

unsigned short	getCurrentICState ()

void	projectInitialConditionOnCustomRange (libMesh::ConstElemRange &elem_range, ConstBndNodeRange &bnd_node_range)

virtual void	addMaterial (const std::string &material_name, const std::string &name, InputParameters &parameters)

virtual void	addMaterialHelper (std::vector< MaterialWarehouse * > warehouse, const std::string &material_name, const std::string &name, InputParameters &parameters)

virtual void	addInterfaceMaterial (const std::string &material_name, const std::string &name, InputParameters &parameters)

virtual void	addFunctorMaterial (const std::string &functor_material_name, const std::string &name, InputParameters &parameters)

void	prepareMaterials (const std::unordered_set< unsigned int > &consumer_needed_mat_props, const SubdomainID blk_id, const THREAD_ID tid)

void	reinitMaterials (SubdomainID blk_id, const THREAD_ID tid, bool swap_stateful=true)

void	reinitMaterialsFace (SubdomainID blk_id, const THREAD_ID tid, bool swap_stateful=true, const std::deque< MaterialBase * > *reinit_mats=nullptr)

void	reinitMaterialsNeighbor (SubdomainID blk_id, const THREAD_ID tid, bool swap_stateful=true, const std::deque< MaterialBase * > *reinit_mats=nullptr)

void	reinitMaterialsBoundary (BoundaryID boundary_id, const THREAD_ID tid, bool swap_stateful=true, const std::deque< MaterialBase * > *reinit_mats=nullptr)

void	reinitMaterialsInterface (BoundaryID boundary_id, const THREAD_ID tid, bool swap_stateful=true)

virtual void	swapBackMaterials (const THREAD_ID tid)

virtual void	swapBackMaterialsFace (const THREAD_ID tid)

virtual void	swapBackMaterialsNeighbor (const THREAD_ID tid)

void	setActiveMaterialProperties (const std::unordered_set< unsigned int > &mat_prop_ids, const THREAD_ID tid)

bool	hasActiveMaterialProperties (const THREAD_ID tid) const

void	clearActiveMaterialProperties (const THREAD_ID tid)

std::vector< std::shared_ptr< T > >	addObject (const std::string &type, const std::string &name, InputParameters &parameters, const bool threaded=true, const std::string &var_param_name="variable")

virtual void	addPostprocessor (const std::string &pp_name, const std::string &name, InputParameters &parameters)

virtual void	addVectorPostprocessor (const std::string &pp_name, const std::string &name, InputParameters &parameters)

virtual void	addReporter (const std::string &type, const std::string &name, InputParameters &parameters)

const ReporterData &	getReporterData () const

ReporterData &	getReporterData (ReporterData::WriteKey)

virtual std::vector< std::shared_ptr< UserObject > >	addUserObject (const std::string &user_object_name, const std::string &name, InputParameters &parameters)

const ExecuteMooseObjectWarehouse< UserObject > &	getUserObjects () const

T &	getUserObject (const std::string &name, unsigned int tid=0) const

const UserObject &	getUserObjectBase (const std::string &name, const THREAD_ID tid=0) const

const Positions &	getPositionsObject (const std::string &name) const

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

bool	hasPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name, std::size_t t_index=0) const

void	setPostprocessorValueByName (const PostprocessorName &name, const PostprocessorValue &value, std::size_t t_index=0)

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

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const std::string &object_name, const std::string &vector_name, std::size_t t_index=0) const

void	setVectorPostprocessorValueByName (const std::string &object_name, const std::string &vector_name, const VectorPostprocessorValue &value, std::size_t t_index=0)

const VectorPostprocessor &	getVectorPostprocessorObjectByName (const std::string &object_name, const THREAD_ID tid=0) const

virtual void	addDamper (const std::string &damper_name, const std::string &name, InputParameters &parameters)

void	setupDampers ()

bool	hasDampers ()

virtual void	addIndicator (const std::string &indicator_name, const std::string &name, InputParameters &parameters)

virtual void	addMarker (const std::string &marker_name, const std::string &name, InputParameters &parameters)

virtual void	addMultiApp (const std::string &multi_app_name, const std::string &name, InputParameters &parameters)

std::shared_ptr< MultiApp >	getMultiApp (const std::string &multi_app_name) const

std::vector< std::shared_ptr< Transfer > >	getTransfers (ExecFlagType type, Transfer::DIRECTION direction) const

std::vector< std::shared_ptr< Transfer > >	getTransfers (Transfer::DIRECTION direction) const

const ExecuteMooseObjectWarehouse< Transfer > &	getMultiAppTransferWarehouse (Transfer::DIRECTION direction) const

void	execMultiAppTransfers (ExecFlagType type, Transfer::DIRECTION direction)

bool	execMultiApps (ExecFlagType type, bool auto_advance=true)

void	finalizeMultiApps ()

void	incrementMultiAppTStep (ExecFlagType type)

void	advanceMultiApps (ExecFlagType type)

void	finishMultiAppStep (ExecFlagType type, bool recurse_through_multiapp_levels=false)

void	backupMultiApps (ExecFlagType type)

void	restoreMultiApps (ExecFlagType type, bool force=false)

Real	computeMultiAppsDT (ExecFlagType type)

virtual void	addTransfer (const std::string &transfer_name, const std::string &name, InputParameters &parameters)

void	execTransfers (ExecFlagType type)

Real	computeResidualL2Norm (NonlinearSystemBase &sys)

Real	computeResidualL2Norm (LinearSystem &sys)

virtual Real	computeResidualL2Norm ()

virtual void	computeResidualSys (libMesh::NonlinearImplicitSystem &sys, const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual)

void	computeResidual (libMesh::NonlinearImplicitSystem &sys, const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual)

virtual void	computeResidual (const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual, const unsigned int nl_sys_num)

void	computeResidualAndJacobian (const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual, libMesh::SparseMatrix< libMesh::Number > &jacobian)

virtual void	computeResidualTag (const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual, TagID tag)

virtual void	computeResidualType (const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual, TagID tag)

virtual void	computeResidualInternal (const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual, const std::set< TagID > &tags)

virtual void	computeResidualTags (const std::set< TagID > &tags)

virtual void	computeJacobianSys (libMesh::NonlinearImplicitSystem &sys, const NumericVector< libMesh::Number > &soln, libMesh::SparseMatrix< libMesh::Number > &jacobian)

virtual void	computeJacobian (const NumericVector< libMesh::Number > &soln, libMesh::SparseMatrix< libMesh::Number > &jacobian, const unsigned int nl_sys_num)

virtual void	computeJacobianTag (const NumericVector< libMesh::Number > &soln, libMesh::SparseMatrix< libMesh::Number > &jacobian, TagID tag)

virtual void	computeJacobianInternal (const NumericVector< libMesh::Number > &soln, libMesh::SparseMatrix< libMesh::Number > &jacobian, const std::set< TagID > &tags)

virtual void	computeJacobianTags (const std::set< TagID > &tags)

virtual void	computeJacobianBlocks (std::vector< JacobianBlock * > &blocks, const unsigned int nl_sys_num)

virtual void	computeJacobianBlock (libMesh::SparseMatrix< libMesh::Number > &jacobian, libMesh::System &precond_system, unsigned int ivar, unsigned int jvar)

virtual void	computeLinearSystemSys (libMesh::LinearImplicitSystem &sys, libMesh::SparseMatrix< libMesh::Number > &system_matrix, NumericVector< libMesh::Number > &rhs, const bool compute_gradients=true)

void	computeLinearSystemTags (const NumericVector< libMesh::Number > &soln, const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags, const bool compute_gradients=true)

virtual Real	computeDamping (const NumericVector< libMesh::Number > &soln, const NumericVector< libMesh::Number > &update)

virtual bool	shouldUpdateSolution ()

virtual bool	updateSolution (NumericVector< libMesh::Number > &vec_solution, NumericVector< libMesh::Number > &ghosted_solution)

virtual void	predictorCleanup (NumericVector< libMesh::Number > &ghosted_solution)

virtual void	computeBounds (libMesh::NonlinearImplicitSystem &sys, NumericVector< libMesh::Number > &lower, NumericVector< libMesh::Number > &upper)

virtual void	computeNearNullSpace (libMesh::NonlinearImplicitSystem &sys, std::vector< NumericVector< libMesh::Number > * > &sp)

virtual void	computeNullSpace (libMesh::NonlinearImplicitSystem &sys, std::vector< NumericVector< libMesh::Number > * > &sp)

virtual void	computeTransposeNullSpace (libMesh::NonlinearImplicitSystem &sys, std::vector< NumericVector< libMesh::Number > * > &sp)

virtual void	computePostCheck (libMesh::NonlinearImplicitSystem &sys, const NumericVector< libMesh::Number > &old_soln, NumericVector< libMesh::Number > &search_direction, NumericVector< libMesh::Number > &new_soln, bool &changed_search_direction, bool &changed_new_soln)

virtual void	computeIndicatorsAndMarkers ()

virtual void	computeIndicators ()

virtual void	computeMarkers ()

virtual void	addResidual (const THREAD_ID tid) override

virtual void	addResidualNeighbor (const THREAD_ID tid) override

virtual void	addResidualLower (const THREAD_ID tid) override

virtual void	addResidualScalar (const THREAD_ID tid=0)

virtual void	cacheResidual (const THREAD_ID tid) override

virtual void	cacheResidualNeighbor (const THREAD_ID tid) override

virtual void	addCachedResidual (const THREAD_ID tid) override

virtual void	addCachedResidualDirectly (NumericVector< libMesh::Number > &residual, const THREAD_ID tid)

virtual void	setResidual (NumericVector< libMesh::Number > &residual, const THREAD_ID tid) override

virtual void	setResidual (libMesh::NumericVector< libMesh::Number > &residual, const THREAD_ID tid)=0

virtual void	setResidualNeighbor (NumericVector< libMesh::Number > &residual, const THREAD_ID tid) override

virtual void	setResidualNeighbor (libMesh::NumericVector< libMesh::Number > &residual, const THREAD_ID tid)=0

virtual void	addJacobian (const THREAD_ID tid) override

virtual void	addJacobianNeighbor (const THREAD_ID tid) override

virtual void	addJacobianNeighbor (libMesh::SparseMatrix< libMesh::Number > &jacobian, unsigned int ivar, unsigned int jvar, const DofMap &dof_map, std::vector< dof_id_type > &dof_indices, std::vector< dof_id_type > &neighbor_dof_indices, const std::set< TagID > &tags, const THREAD_ID tid) override

virtual void	addJacobianNeighbor (libMesh::SparseMatrix< libMesh::Number > &jacobian, unsigned int ivar, unsigned int jvar, const libMesh::DofMap &dof_map, std::vector< dof_id_type > &dof_indices, std::vector< dof_id_type > &neighbor_dof_indices, const std::set< TagID > &tags, const THREAD_ID tid)=0

virtual void	addJacobianNeighborLowerD (const THREAD_ID tid) override

virtual void	addJacobianLowerD (const THREAD_ID tid) override

virtual void	addJacobianBlockTags (libMesh::SparseMatrix< libMesh::Number > &jacobian, unsigned int ivar, unsigned int jvar, const DofMap &dof_map, std::vector< dof_id_type > &dof_indices, const std::set< TagID > &tags, const THREAD_ID tid)

virtual void	addJacobianScalar (const THREAD_ID tid=0)

virtual void	addJacobianOffDiagScalar (unsigned int ivar, const THREAD_ID tid=0)

virtual void	cacheJacobian (const THREAD_ID tid) override

virtual void	cacheJacobianNeighbor (const THREAD_ID tid) override

virtual void	addCachedJacobian (const THREAD_ID tid) override

virtual void	prepareShapes (unsigned int var, const THREAD_ID tid) override

virtual void	prepareFaceShapes (unsigned int var, const THREAD_ID tid) override

virtual void	prepareNeighborShapes (unsigned int var, const THREAD_ID tid) override

virtual void	addDisplacedProblem (std::shared_ptr< DisplacedProblem > displaced_problem)

virtual std::shared_ptr< const DisplacedProblem >	getDisplacedProblem () const

virtual std::shared_ptr< DisplacedProblem >	getDisplacedProblem ()

virtual void	updateGeomSearch (GeometricSearchData::GeometricSearchType type=GeometricSearchData::ALL) override

virtual void	updateMortarMesh ()

void	createMortarInterface (const std::pair< BoundaryID, BoundaryID > &primary_secondary_boundary_pair, const std::pair< SubdomainID, SubdomainID > &primary_secondary_subdomain_pair, bool on_displaced, bool periodic, const bool debug, const bool correct_edge_dropping, const Real minimum_projection_angle)

const std::unordered_map< std::pair< BoundaryID, BoundaryID >, AutomaticMortarGeneration > &	getMortarInterfaces (bool on_displaced) const

virtual void	possiblyRebuildGeomSearchPatches ()

virtual GeometricSearchData &	geomSearchData () override

void	setRestartFile (const std::string &file_name)

const MaterialPropertyRegistry &	getMaterialPropertyRegistry () const

const InitialConditionWarehouse &	getInitialConditionWarehouse () const

const FVInitialConditionWarehouse &	getFVInitialConditionWarehouse () const

SolverParams &	solverParams (unsigned int solver_sys_num=0)

const SolverParams &	solverParams (unsigned int solver_sys_num=0) const

Adaptivity &	adaptivity ()

virtual void	initialAdaptMesh ()

virtual bool	adaptMesh ()

unsigned int	getNumCyclesCompleted ()

bool	hasInitialAdaptivity () const

bool	hasInitialAdaptivity () const

void	initXFEM (std::shared_ptr< XFEMInterface > xfem)

std::shared_ptr< XFEMInterface >	getXFEM ()

bool	haveXFEM ()

virtual bool	updateMeshXFEM ()

virtual void	meshChanged (bool intermediate_change, bool contract_mesh, bool clean_refinement_flags)

void	notifyWhenMeshChanges (MeshChangedInterface *mci)

void	notifyWhenMeshDisplaces (MeshDisplacedInterface *mdi)

void	initElementStatefulProps (const libMesh::ConstElemRange &elem_range, const bool threaded)

virtual void	checkProblemIntegrity ()

void	registerRandomInterface (RandomInterface &random_interface, const std::string &name)

void	setConstJacobian (bool state)

void	setKernelCoverageCheck (CoverageCheckMode mode)

void	setKernelCoverageCheck (bool flag)

void	setKernelCoverageCheck (CoverageCheckMode mode)

void	setMaterialCoverageCheck (CoverageCheckMode mode)

void	setMaterialCoverageCheck (bool flag)

void	setMaterialCoverageCheck (CoverageCheckMode mode)

void	setParallelBarrierMessaging (bool flag)

void	setVerboseProblem (bool verbose)

bool	verboseMultiApps () const

void	parentOutputPositionChanged ()

unsigned int	subspaceDim (const std::string &prefix) const

const MaterialWarehouse &	getMaterialWarehouse () const

const MaterialWarehouse &	getRegularMaterialsWarehouse () const

const MaterialWarehouse &	getDiscreteMaterialWarehouse () const

const MaterialWarehouse &	getInterfaceMaterialsWarehouse () const

std::shared_ptr< MaterialBase >	getMaterial (std::string name, Moose::MaterialDataType type, const THREAD_ID tid=0, bool no_warn=false)

MaterialData &	getMaterialData (Moose::MaterialDataType type, const THREAD_ID tid=0) const

bool	restoreOriginalNonzeroPattern () const

bool	errorOnJacobianNonzeroReallocation () const

void	setErrorOnJacobianNonzeroReallocation (bool state)

bool	preserveMatrixSparsityPattern () const

void	setPreserveMatrixSparsityPattern (bool preserve)

bool	ignoreZerosInJacobian () const

void	setIgnoreZerosInJacobian (bool state)

bool	acceptInvalidSolution () const

bool	allowInvalidSolution () const

bool	showInvalidSolutionConsole () const

bool	immediatelyPrintInvalidSolution () const

bool	hasTimeIntegrator () const

virtual void	execute (const ExecFlagType &exec_type)

virtual void	executeAllObjects (const ExecFlagType &exec_type)

virtual Executor &	getExecutor (const std::string &name)

virtual void	computeUserObjects (const ExecFlagType &type, const Moose::AuxGroup &group)

virtual void	computeUserObjectByName (const ExecFlagType &type, const Moose::AuxGroup &group, const std::string &name)

void	needsPreviousNewtonIteration (bool state)

bool	needsPreviousNewtonIteration () const

ExecuteMooseObjectWarehouse< Control > &	getControlWarehouse ()

void	executeControls (const ExecFlagType &exec_type)

void	executeSamplers (const ExecFlagType &exec_type)

virtual void	updateActiveObjects ()

void	reportMooseObjectDependency (MooseObject a, MooseObject b)

ExecuteMooseObjectWarehouse< MultiApp > &	getMultiAppWarehouse ()

bool	hasJacobian () const

bool	constJacobian () const

void	addOutput (const std::string &, const std::string &, InputParameters &)

TheWarehouse &	theWarehouse () const

void	setSNESMFReuseBase (bool reuse, bool set_by_user)

bool	useSNESMFReuseBase ()

void	skipExceptionCheck (bool skip_exception_check)

bool	isSNESMFReuseBaseSetbyUser ()

bool &	petscOptionsInserted ()

PetscOptions &	petscOptionsDatabase ()

virtual void	setUDotRequested (const bool u_dot_requested)

virtual void	setUDotDotRequested (const bool u_dotdot_requested)

virtual void	setUDotOldRequested (const bool u_dot_old_requested)

virtual void	setUDotDotOldRequested (const bool u_dotdot_old_requested)

virtual bool	uDotRequested ()

virtual bool	uDotDotRequested ()

virtual bool	uDotOldRequested ()

virtual bool	uDotDotOldRequested ()

void	haveADObjects (bool have_ad_objects) override

virtual void	haveADObjects (bool have_ad_objects)

bool	haveADObjects () const

bool	haveADObjects () const

bool	shouldSolve () const

const MortarData &	mortarData () const

MortarData &	mortarData ()

virtual bool	hasNeighborCoupling () const

virtual bool	hasMortarCoupling () const

void	computingNonlinearResid (bool computing_nonlinear_residual) final

bool	computingNonlinearResid () const

virtual void	computingNonlinearResid (const bool computing_nonlinear_residual)

bool	computingNonlinearResid () const

void	setCurrentlyComputingResidual (bool currently_computing_residual) final

void	numGridSteps (unsigned int num_grid_steps)

void	uniformRefine ()

void	automaticScaling (bool automatic_scaling) override

virtual void	automaticScaling (bool automatic_scaling)

bool	automaticScaling () const

bool	automaticScaling () const

virtual void	reinitElemFaceRef (const Elem elem, unsigned int side, Real tolerance, const std::vector< Point > const pts, const std::vector< Real > *const weights=nullptr, const THREAD_ID tid=0) override

virtual void	reinitNeighborFaceRef (const Elem neighbor_elem, unsigned int neighbor_side, Real tolerance, const std::vector< Point > const pts, const std::vector< Real > *const weights=nullptr, const THREAD_ID tid=0) override

bool	fvBCsIntegrityCheck () const

void	fvBCsIntegrityCheck (bool fv_bcs_integrity_check)

void	getFVMatsAndDependencies (SubdomainID block_id, std::vector< std::shared_ptr< MaterialBase >> &face_materials, std::vector< std::shared_ptr< MaterialBase >> &neighbor_materials, std::set< MooseVariableFieldBase * > &variables, const THREAD_ID tid)

void	resizeMaterialData (Moose::MaterialDataType data_type, unsigned int nqp, const THREAD_ID tid)

bool	haveDisplaced () const override final

bool	hasLinearConvergenceObjects () const

void	setNonlinearConvergenceNames (const std::vector< ConvergenceName > &convergence_names)

void	setLinearConvergenceNames (const std::vector< ConvergenceName > &convergence_names)

void	setMultiAppFixedPointConvergenceName (const ConvergenceName &convergence_name)

const std::vector< ConvergenceName > &	getNonlinearConvergenceNames () const

const std::vector< ConvergenceName > &	getLinearConvergenceNames () const

const ConvergenceName &	getMultiAppFixedPointConvergenceName () const

void	computingScalingJacobian (bool computing_scaling_jacobian)

bool	computingScalingJacobian () const override final

void	computingScalingResidual (bool computing_scaling_residual)

bool	computingScalingResidual () const override final

MooseAppCoordTransform &	coordTransform ()

virtual std::size_t	numNonlinearSystems () const override

virtual std::size_t	numLinearSystems () const override

virtual std::size_t	numSolverSystems () const override

bool	isSolverSystemNonlinear (const unsigned int sys_num)

virtual unsigned int	currentNlSysNum () const override

virtual unsigned int	currentLinearSysNum () const override

virtual unsigned int	nlSysNum (const NonlinearSystemName &nl_sys_name) const override

unsigned int	linearSysNum (const LinearSystemName &linear_sys_name) const override

unsigned int	solverSysNum (const SolverSystemName &solver_sys_name) const override

unsigned int	systemNumForVariable (const VariableName &variable_name) const

bool	getFailNextNonlinearConvergenceCheck () const

bool	getFailNextSystemConvergenceCheck () const

void	setFailNextNonlinearConvergenceCheck ()

void	setFailNextSystemConvergenceCheck ()

void	resetFailNextNonlinearConvergenceCheck ()

void	resetFailNextSystemConvergenceCheck ()

void	setExecutionPrinting (const ExecFlagEnum &print_exec)

bool	shouldPrintExecution (const THREAD_ID tid) const

void	reinitMortarUserObjects (BoundaryID primary_boundary_id, BoundaryID secondary_boundary_id, bool displaced)

virtual const std::vector< VectorTag > &	currentResidualVectorTags () const override

void	setCurrentResidualVectorTags (const std::set< TagID > &vector_tags)

void	clearCurrentResidualVectorTags ()

void	clearCurrentJacobianMatrixTags ()

virtual void	needFV () override

virtual bool	haveFV () const override

virtual bool	hasNonlocalCoupling () const override

bool	identifyVariableGroupsInNL () const

virtual void	setCurrentLowerDElem (const Elem *const lower_d_elem, const THREAD_ID tid) override

virtual void	setCurrentBoundaryID (BoundaryID bid, const THREAD_ID tid) override

const std::vector< NonlinearSystemName > &	getNonlinearSystemNames () const

const std::vector< LinearSystemName > &	getLinearSystemNames () const

const std::vector< SolverSystemName > &	getSolverSystemNames () const

virtual const libMesh::CouplingMatrix &	nonlocalCouplingMatrix (const unsigned i) const override

virtual bool	checkNonlocalCouplingRequirement () const override

virtual Moose::FEBackend	feBackend () const

const bool &	currentlyComputingResidual () const

const bool &	currentlyComputingResidual () const

virtual bool	nlConverged (const unsigned int nl_sys_num)

virtual bool	converged (const unsigned int sys_num)

bool	defaultGhosting ()

virtual TagID	addVectorTag (const TagName &tag_name, const Moose::VectorTagType type=Moose::VECTOR_TAG_RESIDUAL)

void	addNotZeroedVectorTag (const TagID tag)

bool	vectorTagNotZeroed (const TagID tag) const

virtual const VectorTag &	getVectorTag (const TagID tag_id) const

std::vector< VectorTag >	getVectorTags (const std::set< TagID > &tag_ids) const

virtual const std::vector< VectorTag > &	getVectorTags (const Moose::VectorTagType type=Moose::VECTOR_TAG_ANY) const

virtual TagID	getVectorTagID (const TagName &tag_name) const

virtual TagName	vectorTagName (const TagID tag) const

virtual bool	vectorTagExists (const TagID tag_id) const

virtual bool	vectorTagExists (const TagName &tag_name) const

virtual unsigned int	numVectorTags (const Moose::VectorTagType type=Moose::VECTOR_TAG_ANY) const

virtual Moose::VectorTagType	vectorTagType (const TagID tag_id) const

virtual TagID	addMatrixTag (TagName tag_name)

virtual TagID	getMatrixTagID (const TagName &tag_name) const

virtual TagName	matrixTagName (TagID tag)

virtual bool	matrixTagExists (const TagName &tag_name) const

virtual bool	matrixTagExists (TagID tag_id) const

virtual unsigned int	numMatrixTags () const

virtual std::map< TagName, TagID > &	getMatrixTags ()

virtual bool	hasLinearVariable (const std::string &var_name) const

virtual bool	hasAuxiliaryVariable (const std::string &var_name) const

virtual const std::set< MooseVariableFieldBase *> &	getActiveElementalMooseVariables (const THREAD_ID tid) const

virtual bool	hasActiveElementalMooseVariables (const THREAD_ID tid) const

Moose::CoordinateSystemType	getCoordSystem (SubdomainID sid) const

unsigned int	getAxisymmetricRadialCoord () const

virtual DiracKernelInfo &	diracKernelInfo ()

void	reinitNeighborLowerDElem (const Elem *elem, const THREAD_ID tid=0)

void	reinitMortarElem (const Elem *elem, const THREAD_ID tid=0)

virtual void	storeSubdomainMatPropName (SubdomainID block_id, const std::string &name)

virtual void	storeBoundaryMatPropName (BoundaryID boundary_id, const std::string &name)

virtual void	storeSubdomainZeroMatProp (SubdomainID block_id, const MaterialPropertyName &name)

virtual void	storeBoundaryZeroMatProp (BoundaryID boundary_id, const MaterialPropertyName &name)

virtual void	storeSubdomainDelayedCheckMatProp (const std::string &requestor, SubdomainID block_id, const std::string &name)

virtual void	storeBoundaryDelayedCheckMatProp (const std::string &requestor, BoundaryID boundary_id, const std::string &name)

virtual void	checkBlockMatProps ()

virtual void	checkBoundaryMatProps ()

virtual void	markMatPropRequested (const std::string &)

virtual bool	isMatPropRequested (const std::string &prop_name) const

void	addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)

const std::map< MooseObjectName, std::set< std::string > > &	getConsumedPropertyMap () const

virtual std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &prop_name)

virtual std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &prop_name)

virtual bool	hasBlockMaterialProperty (SubdomainID block_id, const std::string &prop_name)

virtual std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &prop_name)

virtual std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &prop_name)

virtual bool	hasBoundaryMaterialProperty (BoundaryID boundary_id, const std::string &prop_name)

virtual std::set< dof_id_type > &	ghostedElems ()

const bool &	currentlyComputingJacobian () const

void	setCurrentlyComputingJacobian (const bool currently_computing_jacobian)

const bool &	currentlyComputingResidualAndJacobian () const

void	setCurrentlyComputingResidualAndJacobian (bool currently_computing_residual_and_jacobian)

virtual bool	safeAccessTaggedMatrices () const

virtual bool	safeAccessTaggedVectors () const

const std::set< TagID > &	getActiveScalarVariableCoupleableVectorTags (const THREAD_ID tid) const

const std::set< TagID > &	getActiveScalarVariableCoupleableMatrixTags (const THREAD_ID tid) const

const std::set< TagID > &	getActiveFEVariableCoupleableVectorTags (const THREAD_ID tid) const

const std::set< TagID > &	getActiveFEVariableCoupleableMatrixTags (const THREAD_ID tid) const

void	addAlgebraicGhostingFunctor (libMesh::GhostingFunctor &algebraic_gf, bool to_mesh=true)

void	addCouplingGhostingFunctor (libMesh::GhostingFunctor &coupling_gf, bool to_mesh=true)

void	removeAlgebraicGhostingFunctor (libMesh::GhostingFunctor &algebraic_gf)

void	removeCouplingGhostingFunctor (libMesh::GhostingFunctor &coupling_gf)

void	hasScalingVector (const unsigned int nl_sys_num)

void	clearAllDofIndices ()

const Moose::Functor< T > &	getFunctor (const std::string &name, const THREAD_ID tid, const std::string &requestor_name, bool requestor_is_ad)

bool	hasFunctor (const std::string &name, const THREAD_ID tid) const

bool	hasFunctorWithType (const std::string &name, const THREAD_ID tid) const

void	addFunctor (const std::string &name, const Moose::FunctorBase< T > &functor, const THREAD_ID tid)

const Moose::FunctorBase< T > &	addPiecewiseByBlockLambdaFunctor (const std::string &name, PolymorphicLambda my_lammy, const std::set< ExecFlagType > &clearance_schedule, const MooseMesh &mesh, const std::set< SubdomainID > &block_ids, const THREAD_ID tid)

void	setFunctorOutput (bool set_output)

void	registerUnfilledFunctorRequest (T *functor_interface, const std::string &functor_name, const THREAD_ID tid)

void	reinitFVFace (const THREAD_ID tid, const FaceInfo &fi)

void	preparePRefinement ()

bool	doingPRefinement () const

bool	havePRefinement () const

MooseVariableFEBase &	getVariableHelper (const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type, Moose::VarFieldType expected_var_field_type, const std::vector< T > &systems, const SystemBase &aux) const

void	_setCLIOption ()

virtual void	terminateSolve ()

virtual bool	isSolveTerminationRequested () const

const ConsoleStream &	console () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

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

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

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

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

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

bool	isParamSetByUser (const std::string &nm) const

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

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

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

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

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

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

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

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

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

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

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

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const libMesh::ConstElemRange &	getEvaluableElementRange ()

const libMesh::ConstElemRange &	getEvaluableElementRange ()

const libMesh::ConstElemRange &	getNonlinearEvaluableElementRange ()

const libMesh::ConstElemRange &	getNonlinearEvaluableElementRange ()

const libMesh::ConstElemRange &	getCurrentAlgebraicElementRange ()

const libMesh::ConstElemRange &	getCurrentAlgebraicElementRange ()

const libMesh::ConstNodeRange &	getCurrentAlgebraicNodeRange ()

const libMesh::ConstNodeRange &	getCurrentAlgebraicNodeRange ()

const ConstBndNodeRange &	getCurrentAlgebraicBndNodeRange ()

const ConstBndNodeRange &	getCurrentAlgebraicBndNodeRange ()

void	setCurrentAlgebraicElementRange (libMesh::ConstElemRange *range)

void	setCurrentAlgebraicElementRange (libMesh::ConstElemRange *range)

void	setCurrentAlgebraicNodeRange (libMesh::ConstNodeRange *range)

void	setCurrentAlgebraicNodeRange (libMesh::ConstNodeRange *range)

void	setCurrentAlgebraicBndNodeRange (ConstBndNodeRange *range)

void	setCurrentAlgebraicBndNodeRange (ConstBndNodeRange *range)

void	allowOutput (bool state)

void	allowOutput (bool state)

void	allowOutput (bool state)

void	allowOutput (bool state)

bool	hasMultiApps () const

bool	hasMultiApps (ExecFlagType type) const

bool	hasMultiApps () const

bool	hasMultiApps (ExecFlagType type) const

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

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

const AutomaticMortarGeneration &	getMortarInterface (const std::pair< BoundaryID, BoundaryID > &primary_secondary_boundary_pair, const std::pair< SubdomainID, SubdomainID > &primary_secondary_subdomain_pair, bool on_displaced) const

AutomaticMortarGeneration &	getMortarInterface (const std::pair< BoundaryID, BoundaryID > &primary_secondary_boundary_pair, const std::pair< SubdomainID, SubdomainID > &primary_secondary_subdomain_pair, bool on_displaced)

const AutomaticMortarGeneration &	getMortarInterface (const std::pair< BoundaryID, BoundaryID > &primary_secondary_boundary_pair, const std::pair< SubdomainID, SubdomainID > &primary_secondary_subdomain_pair, bool on_displaced) const

AutomaticMortarGeneration &	getMortarInterface (const std::pair< BoundaryID, BoundaryID > &primary_secondary_boundary_pair, const std::pair< SubdomainID, SubdomainID > &primary_secondary_subdomain_pair, bool on_displaced)

const MaterialPropertyStorage &	getMaterialPropertyStorage ()

const MaterialPropertyStorage &	getMaterialPropertyStorage ()

const MaterialPropertyStorage &	getBndMaterialPropertyStorage ()

const MaterialPropertyStorage &	getBndMaterialPropertyStorage ()

const MaterialPropertyStorage &	getNeighborMaterialPropertyStorage ()

const MaterialPropertyStorage &	getNeighborMaterialPropertyStorage ()

const MooseObjectWarehouse< Indicator > &	getIndicatorWarehouse ()

const MooseObjectWarehouse< Indicator > &	getIndicatorWarehouse ()

const MooseObjectWarehouse< InternalSideIndicatorBase > &	getInternalSideIndicatorWarehouse ()

const MooseObjectWarehouse< InternalSideIndicatorBase > &	getInternalSideIndicatorWarehouse ()

const MooseObjectWarehouse< Marker > &	getMarkerWarehouse ()

const MooseObjectWarehouse< Marker > &	getMarkerWarehouse ()

bool	needBoundaryMaterialOnSide (BoundaryID bnd_id, const THREAD_ID tid)

bool	needBoundaryMaterialOnSide (BoundaryID bnd_id, const THREAD_ID tid)

bool	needInterfaceMaterialOnSide (BoundaryID bnd_id, const THREAD_ID tid)

bool	needInterfaceMaterialOnSide (BoundaryID bnd_id, const THREAD_ID tid)

bool	needSubdomainMaterialOnSide (SubdomainID subdomain_id, const THREAD_ID tid)

bool	needSubdomainMaterialOnSide (SubdomainID subdomain_id, const THREAD_ID tid)

const ExecFlagType &	getCurrentExecuteOnFlag () const

const ExecFlagType &	getCurrentExecuteOnFlag () const

void	setCurrentExecuteOnFlag (const ExecFlagType &)

void	setCurrentExecuteOnFlag (const ExecFlagType &)

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	selectVectorTagsFromSystem (const SystemBase &system, const std::vector< VectorTag > &input_vector_tags, std::set< TagID > &selected_tags)

static void	selectMatrixTagsFromSystem (const SystemBase &system, const std::map< TagName, TagID > &input_matrix_tags, std::set< TagID > &selected_tags)

static void	objectSetupHelper (const std::vector< T * > &objects, const ExecFlagType &exec_flag)

static void	objectSetupHelper (const std::vector< T * > &objects, const ExecFlagType &exec_flag)

static void	objectExecuteHelper (const std::vector< T * > &objects)

static void	objectExecuteHelper (const std::vector< T * > &objects)

Public Attributes
std::map< std::string, std::vector< dof_id_type > >	_var_dof_map

const ConsoleStream	_console

std::vector< Real >	_real_zero

std::vector< VariableValue >	_scalar_zero

std::vector< VariableValue >	_zero

std::vector< VariablePhiValue >	_phi_zero

std::vector< MooseArray< ADReal > >	_ad_zero

std::vector< VariableGradient >	_grad_zero

std::vector< MooseArray< ADRealVectorValue > >	_ad_grad_zero

std::vector< VariablePhiGradient >	_grad_phi_zero

std::vector< VariableSecond >	_second_zero

std::vector< MooseArray< ADRealTensorValue > >	_ad_second_zero

std::vector< VariablePhiSecond >	_second_phi_zero

std::vector< Point >	_point_zero

std::vector< VectorVariableValue >	_vector_zero

std::vector< VectorVariableCurl >	_vector_curl_zero

Protected Member Functions
virtual void	initPetscOutputAndSomeSolverSettings () override
	Reinitialize PETSc output for proper linear/nonlinear iteration display. More...

virtual void	meshChanged ()

MooseVariableFieldBase &	getVariableHelper (const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type, Moose::VarFieldType expected_var_field_type, const std::vector< T > &nls, const SystemBase &aux) const

void	createTagVectors ()

void	createTagSolutions ()

virtual void	meshDisplaced ()

void	computeSystems (const ExecFlagType &type)

bool	duplicateVariableCheck (const std::string &var_name, const libMesh::FEType &type, bool is_aux, const std::set< SubdomainID > *const active_subdomains)

void	computeUserObjectsInternal (const ExecFlagType &type, const Moose::AuxGroup &group, TheWarehouse::Query &query)

void	checkDisplacementOrders ()

void	checkUserObjects ()

void	checkDependMaterialsHelper (const std::map< SubdomainID, std::vector< std::shared_ptr< MaterialBase >>> &materials_map)

void	checkCoordinateSystems ()

void	reinitBecauseOfGhostingOrNewGeomObjects (bool mortar_changed=false)

void	addObjectParamsHelper (InputParameters &params, const std::string &object_name, const std::string &var_param_name="variable")

bool	verifyVectorTags () const

void	markFamilyPRefinement (const InputParameters &params)

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

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

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

Protected Attributes
bool	_use_nonlinear

std::vector< std::shared_ptr< NonlinearSystem > >	_nl_sys

MooseMesh &	_mesh

bool	_initialized

std::optional< std::vector< ConvergenceName > >	_nonlinear_convergence_names

std::optional< std::vector< ConvergenceName > >	_linear_convergence_names

std::optional< ConvergenceName >	_multiapp_fixed_point_convergence_name

std::set< TagID >	_fe_vector_tags

std::set< TagID >	_fe_matrix_tags

std::set< TagID >	_linear_vector_tags

std::set< TagID >	_linear_matrix_tags

const bool &	_solve

bool	_transient

Real &	_time

Real &	_time_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_need_to_add_default_nonlinear_convergence

bool	_need_to_add_default_multiapp_fixed_point_convergence

const std::vector< LinearSystemName >	_linear_sys_names

const std::size_t	_num_linear_sys

std::vector< std::shared_ptr< LinearSystem > >	_linear_systems

std::map< LinearSystemName, unsigned int >	_linear_sys_name_to_num

LinearSystem *	_current_linear_sys

const bool	_using_default_nl

const std::vector< NonlinearSystemName >	_nl_sys_names

const std::size_t	_num_nl_sys

std::map< NonlinearSystemName, unsigned int >	_nl_sys_name_to_num

NonlinearSystemBase *	_current_nl_sys

SolverSystem *	_current_solver_sys

std::vector< std::shared_ptr< SolverSystem > >	_solver_systems

std::map< SolverVariableName, unsigned int >	_solver_var_to_sys_num

std::map< SolverSystemName, unsigned int >	_solver_sys_name_to_num

std::vector< SolverSystemName >	_solver_sys_names

std::shared_ptr< AuxiliarySystem >	_aux

Moose::CouplingType	_coupling

std::vector< std::unique_ptr< libMesh::CouplingMatrix > >	_cm

std::map< std::string, unsigned int >	_subspace_dim

std::vector< std::vector< std::unique_ptr< Assembly > > >	_assembly

MooseObjectWarehouse< MeshDivision >	_mesh_divisions

MooseObjectWarehouse< Function >	_functions

MooseObjectWarehouse< Convergence >	_convergences

MooseObjectWarehouse< KernelBase >	_nonlocal_kernels

MooseObjectWarehouse< IntegratedBCBase >	_nonlocal_integrated_bcs

MaterialPropertyRegistry	_material_prop_registry

MaterialPropertyStorage &	_material_props

MaterialPropertyStorage &	_bnd_material_props

MaterialPropertyStorage &	_neighbor_material_props

MooseObjectWarehouse< Marker >	_markers

ReporterData	_reporter_data

ExecuteMooseObjectWarehouse< UserObject >	_all_user_objects

ExecuteMooseObjectWarehouse< MultiApp >	_multi_apps

ExecuteMooseObjectWarehouse< TransientMultiApp >	_transient_multi_apps

ExecuteMooseObjectWarehouse< Transfer >	_transfers

ExecuteMooseObjectWarehouse< Transfer >	_to_multi_app_transfers

ExecuteMooseObjectWarehouse< Transfer >	_from_multi_app_transfers

ExecuteMooseObjectWarehouse< Transfer >	_between_multi_app_transfers

std::map< std::string, std::unique_ptr< RandomData > >	_random_data_objects

std::vector< std::unordered_map< SubdomainID, bool > >	_block_mat_side_cache

std::vector< std::unordered_map< BoundaryID, bool > >	_bnd_mat_side_cache

std::vector< std::unordered_map< BoundaryID, bool > >	_interface_mat_side_cache

std::vector< MeshChangedInterface *>	_notify_when_mesh_changes

std::vector< MeshDisplacedInterface *>	_notify_when_mesh_displaces

Adaptivity	_adaptivity

unsigned int	_cycles_completed

std::shared_ptr< XFEMInterface >	_xfem

MooseMesh *	_displaced_mesh

std::shared_ptr< DisplacedProblem >	_displaced_problem

GeometricSearchData	_geometric_search_data

MortarData	_mortar_data

bool	_reinit_displaced_elem

bool	_reinit_displaced_face

bool	_reinit_displaced_neighbor

bool	_input_file_saved

bool	_has_dampers

bool	_has_constraints

bool	_snesmf_reuse_base

bool	_skip_exception_check

bool	_snesmf_reuse_base_set_by_user

bool	_has_initialized_stateful

bool	_const_jacobian

bool	_has_jacobian

bool	_needs_old_newton_iter

bool	_previous_nl_solution_required

bool	_has_nonlocal_coupling

bool	_calculate_jacobian_in_uo

std::vector< std::vector< const MooseVariableFEBase *> >	_uo_jacobian_moose_vars

std::vector< unsigned char >	_has_active_material_properties

std::vector< SolverParams >	_solver_params

CoverageCheckMode	_kernel_coverage_check

std::vector< SubdomainName >	_kernel_coverage_blocks

const bool	_boundary_restricted_node_integrity_check

const bool	_boundary_restricted_elem_integrity_check

CoverageCheckMode	_material_coverage_check

std::vector< SubdomainName >	_material_coverage_blocks

bool	_fv_bcs_integrity_check

const bool	_material_dependency_check

const bool	_uo_aux_state_check

unsigned int	_max_qps

libMesh::Order	_max_scalar_order

bool	_has_time_integrator

bool	_has_exception

bool	_parallel_barrier_messaging

MooseEnum	_verbose_setup

bool	_verbose_multiapps

bool	_verbose_restore

std::string	_exception_message

ExecFlagType	_current_execute_on_flag

ExecuteMooseObjectWarehouse< Control >	_control_warehouse

Moose::PetscSupport::PetscOptions	_petsc_options

PetscOptions	_petsc_option_data_base

bool	_is_petsc_options_inserted

std::shared_ptr< LineSearch >	_line_search

std::unique_ptr< libMesh::ConstElemRange >	_evaluable_local_elem_range

std::unique_ptr< libMesh::ConstElemRange >	_nl_evaluable_local_elem_range

std::unique_ptr< libMesh::ConstElemRange >	_aux_evaluable_local_elem_range

std::unique_ptr< libMesh::ConstElemRange >	_current_algebraic_elem_range

std::unique_ptr< libMesh::ConstNodeRange >	_current_algebraic_node_range

std::unique_ptr< ConstBndNodeRange >	_current_algebraic_bnd_node_range

bool	_using_ad_mat_props

unsigned short	_current_ic_state

const bool	_use_hash_table_matrix_assembly

std::map< TagName, TagID >	_matrix_tag_name_to_tag_id

std::map< TagID, TagName >	_matrix_tag_id_to_tag_name

Factory &	_factory

DiracKernelInfo	_dirac_kernel_info

std::map< SubdomainID, std::set< std::string > >	_map_block_material_props

std::map< BoundaryID, std::set< std::string > >	_map_boundary_material_props

std::map< SubdomainID, std::set< MaterialPropertyName > >	_zero_block_material_props

std::map< BoundaryID, std::set< MaterialPropertyName > >	_zero_boundary_material_props

std::set< std::string >	_material_property_requested

std::vector< std::set< MooseVariableFieldBase *> >	_active_elemental_moose_variables

std::vector< unsigned int >	_has_active_elemental_moose_variables

std::vector< std::set< TagID > >	_active_fe_var_coupleable_matrix_tags

std::vector< std::set< TagID > >	_active_fe_var_coupleable_vector_tags

std::vector< std::set< TagID > >	_active_sc_var_coupleable_matrix_tags

std::vector< std::set< TagID > >	_active_sc_var_coupleable_vector_tags

bool	_default_ghosting

std::set< dof_id_type >	_ghosted_elems

bool	_currently_computing_jacobian

bool	_currently_computing_residual_and_jacobian

bool	_computing_nonlinear_residual

bool	_currently_computing_residual

bool	_safe_access_tagged_matrices

bool	_safe_access_tagged_vectors

bool	_have_ad_objects

std::unordered_set< TagID >	_not_zeroed_tagged_vectors

bool	_cli_option_found

bool	_color_output

bool	_termination_requested

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

ActionFactory &	_action_factory

MooseApp &	_pg_moose_app

const std::string	_prefix

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

InitialConditionWarehouse	_ics

FVInitialConditionWarehouse	_fv_ics

ScalarInitialConditionWarehouse	_scalar_ics

MaterialWarehouse	_materials

MaterialWarehouse	_interface_materials

MaterialWarehouse	_discrete_materials

MaterialWarehouse	_all_materials

MooseObjectWarehouse< Indicator >	_indicators

MooseObjectWarehouse< InternalSideIndicatorBase >	_internal_side_indicators

std::map< SubdomainID, std::multimap< std::string, std::string > >	_map_block_material_props_check

std::map< BoundaryID, std::multimap< std::string, std::string > >	_map_boundary_material_props_check

const Parallel::Communicator &	_communicator

Private Attributes
const bool	_commute_lsc
	Whether to commute operators in the style of Olshanskii. More...

const TagName &	_mass_matrix
	The tag name of the mass matrix. More...

const TagName &	_L_matrix
	The tag name of the Poisson operator. More...

const bool	_have_mass_matrix
	Whether the user attached a mass matrix. More...

const bool	_have_L_matrix
	Whether the user attached a Poisson operator matrix. More...

const bool	_pressure_mass_matrix_as_pre
	Whether to directly use the pressure mass matrix to form the Schur complement preconditioner. More...

const std::vector< unsigned int > &	_schur_fs_index
	The length of this vector should correspond to the number of split nesting levels there are in the field split. More...

Mat	_Q_scale = nullptr
	The mass matrix used for scaling. More...

Mat	_L = nullptr
	The Poisson operator. More...

std::vector< IS >	_index_sets
	This will end up being the same length as `_schur_fs_index`. More...

Detailed Description

A problem that handles Schur complement preconditioning of the incompressible Navier-Stokes equations.

Definition at line 22 of file NavierStokesProblem.h.

Constructor & Destructor Documentation

◆ NavierStokesProblem()

NavierStokesProblem::NavierStokesProblem ( const InputParameters & parameters )

Definition at line 46 of file NavierStokesProblem.C.

                                                                            : FEProblem(parameters)
 #if PETSC_RELEASE_LESS_THAN(3, 20, 0)
 {
   mooseError("The preconditioning techniques made available through this class require a PETSc "
              "version of at least 3.20");
 }

◆ ~NavierStokesProblem()

NavierStokesProblem::~NavierStokesProblem ( )

virtual

Will destroy any matrices we allocated.

Definition at line 84 of file NavierStokesProblem.C.

 {
   auto ierr = (PetscErrorCode)0;
   if (_Q_scale)
   {
     ierr = MatDestroy(&_Q_scale);
     CHKERRABORT(this->comm().get(), ierr);
   }
   if (_L)
   {
     ierr = MatDestroy(&_L);
     CHKERRABORT(this->comm().get(), ierr);
   }
 }

Member Function Documentation

◆ clearIndexSets()

void NavierStokesProblem::clearIndexSets ( )

inline

Clear the field split index sets.

Definition at line 43 of file NavierStokesProblem.h.

Referenced by navierStokesKSPPreSolve().

43 { _index_sets.clear(); }

NavierStokesProblem::_index_sets

std::vector< IS > _index_sets

This will end up being the same length as _schur_fs_index.

Definition: NavierStokesProblem.h:109

◆ findSchurKSP()

KSP NavierStokesProblem::findSchurKSP	(	KSP	node,
		unsigned int	tree_position
	)

Definition at line 100 of file NavierStokesProblem.C.

 {
   auto it = _schur_fs_index.begin() + tree_position;
   if (it == _schur_fs_index.end())
     return node;
 
   PC fs_pc;
   PetscInt num_splits;
   KSP * subksp;
   KSP next_ksp;
   IS is;
   PetscBool is_fs;
 
   auto sub_ksp_index = *it;
 
   // Get the preconditioner associated with the linear solver
   LibmeshPetscCall(KSPGetPC(node, &fs_pc));
 
   // Verify the preconditioner is a field split preconditioner
   LibmeshPetscCall(PetscObjectTypeCompare((PetscObject)fs_pc, PCFIELDSPLIT, &is_fs));
   if (!is_fs)
     mooseError("Not a field split. Please check the 'schur_fs_index' parameter");
 
   // Setup the preconditioner. We need to call this first in order to be able to retrieve the sub
   // ksps and sub index sets associated with the splits
   LibmeshPetscCall(PCSetUp(fs_pc));
 
   // Get the linear solvers associated with each split
   LibmeshPetscCall(PCFieldSplitGetSubKSP(fs_pc, &num_splits, &subksp));
   next_ksp = subksp[sub_ksp_index];
 
   // Get the index set for the split at this level of the tree we are traversing to the Schur
   // complement preconditioner
   LibmeshPetscCall(PCFieldSplitGetISByIndex(fs_pc, sub_ksp_index, &is));
 
   // Store this tree level's index set, which we will eventually use to get the sub-matrices
   // required for our preconditioning process from the system matrix
   _index_sets.push_back(is);
 
   // Free the array of sub linear solvers that got allocated in the PCFieldSplitGetSubKSP call
   LibmeshPetscCall(PetscFree(subksp));
 
   // Continue traversing down the tree towards the Schur complement linear solver/preconditioner
   return findSchurKSP(next_ksp, tree_position + 1);
 }

◆ initPetscOutputAndSomeSolverSettings()

void NavierStokesProblem::initPetscOutputAndSomeSolverSettings ( )

overrideprotectedvirtual

Reinitialize PETSc output for proper linear/nonlinear iteration display.

Reimplemented from FEProblem.

Definition at line 355 of file NavierStokesProblem.C.

 {
   FEProblem::initPetscOutputAndSomeSolverSettings();
 
   if (!_have_mass_matrix)
   {
     mooseAssert(
         !_have_L_matrix,
         "If we don't have a mass matrix, which is only supported for traditional LSC "
         "preconditioning (e.g. Elman, not Olshanskii), then we also shouldn't have an L matrix "
         "because we automatically form the L matrix when doing traditional LSC preconditioning");
     return;
   }
 
   // Set the pre-KSP solve callback. At that time we will setup our Schur complement preconditioning
   KSP ksp;
   auto snes = currentNonlinearSystem().getSNES();
   LibmeshPetscCall(SNESGetKSP(snes, &ksp));
   LibmeshPetscCall(KSPSetPreSolve(ksp, &navierStokesKSPPreSolve, this));
 }

◆ LMatrixTagID()

TagID NavierStokesProblem::LMatrixTagID ( ) const

inline

Returns: the poisson operator matrix tag ID

Definition at line 38 of file NavierStokesProblem.h.

Referenced by setupLSCMatrices().

38 { return getMatrixTagID(_L_matrix); }

FEProblem::getMatrixTagID

virtual TagID getMatrixTagID(const TagName &tag_name) const

NavierStokesProblem::_L_matrix

const TagName & _L_matrix

The tag name of the Poisson operator.

Definition: NavierStokesProblem.h:77

◆ massMatrixTagID()

TagID NavierStokesProblem::massMatrixTagID ( ) const

inline

Returns: the mass matrix tag ID

Definition at line 33 of file NavierStokesProblem.h.

Referenced by setupLSCMatrices().

33 { return getMatrixTagID(_mass_matrix); }

FEProblem::getMatrixTagID

virtual TagID getMatrixTagID(const TagName &tag_name) const

NavierStokesProblem::_mass_matrix

const TagName & _mass_matrix

The tag name of the mass matrix.

Definition: NavierStokesProblem.h:75

◆ setupLSCMatrices()

void NavierStokesProblem::setupLSCMatrices ( KSP schur_ksp )

Setup the Least Squares Commutator (LSC) preconditioner given the Schur complement KSP object.

Definition at line 147 of file NavierStokesProblem.C.

 {
   KSP * subksp; // This will be length two, with the former being the A KSP and the latter being the
                 // Schur complement KSP
   KSP schur_complement_ksp;
   PC schur_pc, lsc_pc;
   PetscInt num_splits;
   Mat lsc_pc_pmat;
   IS velocity_is, pressure_is;
   PetscInt rstart, rend;
   PetscBool is_lsc, is_fs;
   std::vector<Mat> intermediate_Qs;
   std::vector<Mat> intermediate_Ls;
 
   // Get the preconditioner for the linear solver. It must be a field split preconditioner
   LibmeshPetscCall(KSPGetPC(schur_ksp, &schur_pc));
   LibmeshPetscCall(PetscObjectTypeCompare((PetscObject)schur_pc, PCFIELDSPLIT, &is_fs));
   if (!is_fs)
     mooseError("Not a field split. Please check the 'schur_fs_index' parameter");
 
   // The mass matrix. This will correspond to velocity degrees of freedom for Elman LSC and pressure
   // degrees of freedom for Olshanskii LSC or when directly using the mass matrix as a
   // preconditioner for the Schur complement
   Mat global_Q = nullptr;
   if (_have_mass_matrix)
     global_Q =
         static_cast<PetscMatrix<Number> &>(getNonlinearSystemBase(0).getMatrix(massMatrixTagID()))
             .mat();
   // The Poisson operator matrix corresponding to the velocity degrees of freedom. This is only used
   // and is required for Olshanskii LSC preconditioning
   Mat global_L = nullptr;
   if (_have_L_matrix)
     global_L =
         static_cast<PetscMatrix<Number> &>(getNonlinearSystemBase(0).getMatrix(LMatrixTagID()))
             .mat();
 
   //
   // Process down from our system matrix to the sub-matrix containing the velocity-pressure dofs for
   // which we are going to be doing the Schur complement preconditioning
   //
 
   auto process_intermediate_mats = [this](auto & intermediate_mats, auto parent_mat)
   {
     mooseAssert(parent_mat, "This should be non-null");
     intermediate_mats.resize(_index_sets.size());
     for (const auto i : index_range(_index_sets))
     {
       auto intermediate_is = _index_sets[i];
       Mat intermediate_mat;
       LibmeshPetscCall(MatCreateSubMatrix(i == 0 ? parent_mat : intermediate_mats[i - 1],
                                           intermediate_is,
                                           intermediate_is,
                                           MAT_INITIAL_MATRIX,
                                           &intermediate_mat));
       intermediate_mats[i] = intermediate_mat;
     }
     return _index_sets.empty() ? parent_mat : intermediate_mats.back();
   };
 
   Mat our_parent_Q = nullptr;
   if (_have_mass_matrix)
     our_parent_Q = process_intermediate_mats(intermediate_Qs, global_Q);
   Mat our_parent_L = nullptr;
   if (_have_L_matrix)
     our_parent_L = process_intermediate_mats(intermediate_Ls, global_L);
 
   // Setup the preconditioner. We need to call this first in order to be able to retrieve the sub
   // ksps and sub index sets associated with the splits
   LibmeshPetscCall(PCSetUp(schur_pc));
 
   // There are always two splits in a Schur complement split. The zeroth split is the split with the
   // on-diagonals, e.g. the velocity dofs. Here we retrive the velocity dofs/index set
   LibmeshPetscCall(PCFieldSplitGetISByIndex(schur_pc, 0, &velocity_is));
 
   // Get the rows of the parent velocity-pressure matrix that our process owns
   LibmeshPetscCall(MatGetOwnershipRange(our_parent_Q, &rstart, &rend));
 
   if (_commute_lsc)
   {
     // If we're commuting LSC, e.g. doing Olshanskii, the user must have provided a Poisson operator
     // matrix
     mooseAssert(our_parent_L, "This should be non-null");
 
     if (!_L)
       // If this is our first time in this routine, then we create the matrix
       LibmeshPetscCall(
           MatCreateSubMatrix(our_parent_L, velocity_is, velocity_is, MAT_INITIAL_MATRIX, &_L));
     else
       // Else we reuse the matrix
       LibmeshPetscCall(
           MatCreateSubMatrix(our_parent_L, velocity_is, velocity_is, MAT_REUSE_MATRIX, &_L));
   }
 
   // Get the local index set complement corresponding to the pressure dofs from the velocity dofs
   LibmeshPetscCall(ISComplement(velocity_is, rstart, rend, &pressure_is));
 
   auto create_q_scale_submat =
       [our_parent_Q, this, velocity_is, pressure_is](const auto & mat_initialization)
   {
     if (_commute_lsc || _pressure_mass_matrix_as_pre)
     {
       // If we are doing Olshanskii or we are using the pressure matrix directly as the
       // preconditioner (no LSC), then we must have access to a pressure mass matrix
       mooseAssert(our_parent_Q, "This should be non-null");
       // Create a sub-matrix corresponding to the pressure index set
       LibmeshPetscCall(MatCreateSubMatrix(
           our_parent_Q, pressure_is, pressure_is, mat_initialization, &_Q_scale));
     }
     else if (_have_mass_matrix) // If we don't have a mass matrix and the user has requested scaling
                                 // then the diagonal of A will be used
     {
       // The user passed us a mass matrix tag; we better have been able to obtain a parent Q in that
       // case
       mooseAssert(our_parent_Q, "This should be non-null");
       // We are not commuting LSC, so we are doing Elman, and the user has passed us a mass matrix
       // tag. In this case we are creating a velocity mass matrix, so we use the velocity index set
       LibmeshPetscCall(MatCreateSubMatrix(
           our_parent_Q, velocity_is, velocity_is, mat_initialization, &_Q_scale));
     }
   };
 
   if (!_Q_scale)
     // We haven't allocated the scaling matrix yet
     create_q_scale_submat(MAT_INITIAL_MATRIX);
   else
     // We have allocated the scaling matrix, so we can reuse
     create_q_scale_submat(MAT_REUSE_MATRIX);
 
   // We don't need the pressure index set anymore
   LibmeshPetscCall(ISDestroy(&pressure_is));
 
   // Nor the intermediate matrices
   for (auto & mat : intermediate_Qs)
     LibmeshPetscCall(MatDestroy(&mat));
   for (auto & mat : intermediate_Ls)
     LibmeshPetscCall(MatDestroy(&mat));
 
   // Get the sub KSP for the Schur split that corresponds to the linear solver for the Schur
   // complement (e.g. rank equivalent to the pressure rank)
   LibmeshPetscCall(PCFieldSplitGetSubKSP(schur_pc, &num_splits, &subksp));
   if (num_splits != 2)
     mooseError("The number of splits should be two");
   // The Schur complement linear solver is always at the first index (for the pressure dofs;
   // velocity dof KSP is at index 0)
   schur_complement_ksp = subksp[1];
 
   if (_pressure_mass_matrix_as_pre)
   {
     mooseAssert(_Q_scale, "This should be non-null");
     Mat S;
     // Set the Schur complement preconditioner to be the pressure mass matrix
     LibmeshPetscCall(PCFieldSplitSetSchurPre(schur_pc, PC_FIELDSPLIT_SCHUR_PRE_USER, _Q_scale));
     // Get the Schur complement operator S, which in generic KSP speak is used for the operator A
     LibmeshPetscCall(KSPGetOperators(schur_complement_ksp, &S, NULL));
     // Set, in generic KSP speak, the operators A and P respectively. So our pressure mass matrix is
     // P
     LibmeshPetscCall(KSPSetOperators(schur_complement_ksp, S, _Q_scale));
   }
   else // We are doing LSC preconditioning
   {
     // Get the least squares commutator preconditioner for the Schur complement
     LibmeshPetscCall(KSPGetPC(schur_complement_ksp, &lsc_pc));
     // Verify that it's indeed an LSC preconditioner
     LibmeshPetscCall(PetscObjectTypeCompare(PetscObject(lsc_pc), PCLSC, &is_lsc));
     if (!is_lsc)
       mooseError("Not an LSC PC. Please check the 'schur_fs_index' parameter");
 
     // Get the LSC preconditioner
     LibmeshPetscCall(PCGetOperators(lsc_pc, NULL, &lsc_pc_pmat));
 
     if (_commute_lsc)
     {
       // We're doing Olshanskii. We must have a user-provided Poisson operator
       mooseAssert(_L, "This should be non-null");
       // Attach our L matrix to the PETSc object. PETSc will use this during the preconditioner
       // application
       LibmeshPetscCall(PetscObjectCompose((PetscObject)lsc_pc_pmat, "LSC_L", (PetscObject)_L));
       // Olshanskii preconditioning requires a pressure mass matrix
       mooseAssert(_have_mass_matrix, "This is to verify we will enter the next conditional");
     }
     if (_have_mass_matrix)
     {
       mooseAssert(_Q_scale, "This should be non-null");
       // Attach our scaling/mass matrix to the PETSc object. PETSc will use this during the
       // preconditioner application
       LibmeshPetscCall(
           PetscObjectCompose((PetscObject)lsc_pc_pmat, "LSC_Qscale", (PetscObject)_Q_scale));
     }
   }
 
   // Free the sub-KSP array that was allocated during PCFieldSplitGetSubKSP
   LibmeshPetscCall(PetscFree(subksp));
 }

◆ validParams()

InputParameters NavierStokesProblem::validParams ( )

static

Definition at line 19 of file NavierStokesProblem.C.

 {
   InputParameters params = FEProblem::validParams();
   params.addClassDescription("A problem that handles Schur complement preconditioning of the "
                              "incompressible Navier-Stokes equations");
   params.addParam<TagName>(
       "mass_matrix", "", "The matrix tag name corresponding to the mass matrix.");
   params.addParam<TagName>(
       "L_matrix",
       "",
       "The matrix tag name corresponding to the diffusive part of the velocity equations.");
   params.addParam<std::vector<unsigned int>>(
       "schur_fs_index",
       {},
       "if not provided then the top field split is assumed to be the "
       "Schur split. This is a vector to allow recursive nesting");
   params.addParam<bool>("use_pressure_mass_matrix",
                         false,
                         "Whether to just use the pressure mass matrix as the preconditioner for "
                         "the Schur complement");
   params.addParam<bool>(
       "commute_lsc",
       false,
       "Whether to use the commuted form of the LSC preconditioner, created by Olshanskii");
   return params;
 }

Member Data Documentation

◆ _commute_lsc

const bool NavierStokesProblem::_commute_lsc

private

Whether to commute operators in the style of Olshanskii.

If this is true, then the user must provide both (pressure) mass matrices and a Poisson operator for the velocity

Definition at line 73 of file NavierStokesProblem.h.

Referenced by setupLSCMatrices().

◆ _have_L_matrix

const bool NavierStokesProblem::_have_L_matrix

private

Whether the user attached a Poisson operator matrix.

Definition at line 81 of file NavierStokesProblem.h.

Referenced by initPetscOutputAndSomeSolverSettings(), and setupLSCMatrices().

◆ _have_mass_matrix

const bool NavierStokesProblem::_have_mass_matrix

private

Whether the user attached a mass matrix.

Definition at line 79 of file NavierStokesProblem.h.

Referenced by initPetscOutputAndSomeSolverSettings(), and setupLSCMatrices().

◆ _index_sets

std::vector<IS> NavierStokesProblem::_index_sets

private

This will end up being the same length as _schur_fs_index.

Let's give an example of what this data member means. If the user sets "schur_fs_index = '1'", then this means the Schur complement field split is nested within another field split, and the Schur complement field split is at the 1st index of the top split (some other set of degrees of freedom take up the 0th index of the top split). So in this example _index_sets will be of length 1, and the Index Set (IS) held by this container will hold all the Schur complement field split degrees of freedom (e.g. all the system degrees of freedom minus the degrees of freedom held in the 0th index of the top split). An example of this example is if we split out all the velocity Dirichlet degrees of freedom into the 0th index of the top split, and then our Schur complement at index 1 of the top split handles all non-Dirichlet velocity degrees of freedom and all pressure degrees of freedom

Definition at line 109 of file NavierStokesProblem.h.

Referenced by clearIndexSets(), findSchurKSP(), and setupLSCMatrices().

◆ _L

Mat NavierStokesProblem::_L = nullptr

private

The Poisson operator.

Definition at line 96 of file NavierStokesProblem.h.

Referenced by setupLSCMatrices(), and ~NavierStokesProblem().

◆ _L_matrix

const TagName& NavierStokesProblem::_L_matrix

private

The tag name of the Poisson operator.

Definition at line 77 of file NavierStokesProblem.h.

Referenced by LMatrixTagID().

◆ _mass_matrix

const TagName& NavierStokesProblem::_mass_matrix

private

The tag name of the mass matrix.

Definition at line 75 of file NavierStokesProblem.h.

Referenced by massMatrixTagID().

◆ _pressure_mass_matrix_as_pre

const bool NavierStokesProblem::_pressure_mass_matrix_as_pre

private

Whether to directly use the pressure mass matrix to form the Schur complement preconditioner.

This is only appropriate for Stokes flow in which the pressure mass matrix is spectrally equivalent to the Schur complement

Definition at line 86 of file NavierStokesProblem.h.

Referenced by setupLSCMatrices().

◆ _Q_scale

Mat NavierStokesProblem::_Q_scale = nullptr

private

The mass matrix used for scaling.

Definition at line 94 of file NavierStokesProblem.h.

Referenced by setupLSCMatrices(), and ~NavierStokesProblem().

◆ _schur_fs_index

const std::vector<unsigned int>& NavierStokesProblem::_schur_fs_index

private

The length of this vector should correspond to the number of split nesting levels there are in the field split.

Then the integers should indicate the path one shold take in the nesting tree to get to the location of the Schur complement field split

Definition at line 91 of file NavierStokesProblem.h.

Referenced by findSchurKSP().

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

navier_stokes/include/problems/NavierStokesProblem.h
navier_stokes/src/problems/NavierStokesProblem.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NavierStokesProblem()

◆ ~NavierStokesProblem()

Member Function Documentation

◆ clearIndexSets()

◆ findSchurKSP()

◆ initPetscOutputAndSomeSolverSettings()

◆ LMatrixTagID()

◆ massMatrixTagID()

◆ setupLSCMatrices()

◆ validParams()

Member Data Documentation

◆ _commute_lsc

◆ _have_L_matrix

◆ _have_mass_matrix

◆ _index_sets

◆ _L

◆ _L_matrix

◆ _mass_matrix

◆ _pressure_mass_matrix_as_pre

◆ _Q_scale

◆ _schur_fs_index