This class provides an interface to PETSc iterative solvers that is compatible with the libMesh NonlinearSolver<> More...

#include <petsc_nonlinear_solver.h>

Inheritance diagram for libMesh::PetscNonlinearSolver< T >:

[legend]

Classes
class	ComputeLineSearchObject
	Abstract base class to be used to implement a custom line-search algorithm. More...

Public Types
typedef NonlinearImplicitSystem	sys_type
	The type of system.

Public Member Functions
	PetscNonlinearSolver (sys_type &system)
	Constructor.

	~PetscNonlinearSolver ()
	Destructor.

virtual void	clear () override
	Release all memory and clear data structures.

virtual void	init (const char *name=nullptr) override
	Initialize data structures if not done so already.

SNES	snes (const char *name=nullptr)

virtual std::pair< unsigned int, Real >	solve (SparseMatrix< T > &pre_in, NumericVector< T > &, NumericVector< T > &, const double, const unsigned int) override
	Call the Petsc solver, using the same matrix for the system and preconditioner matrices.

virtual std::pair< unsigned int, Real >	solve (SparseMatrix< T > &jac_in, SparseMatrix< T > &pre_in, NumericVector< T > &, NumericVector< T > &, const double, const unsigned int) override
	Call the Petsc solver, using `jac_in` as the actual SNES Jacobian operator (Amat) and `pre_in` as the preconditioning matrix (Pmat).

virtual void	print_converged_reason () override
	Prints a useful message about why the latest nonlinear solve con(di)verged.

SNESConvergedReason	get_converged_reason ()

virtual int	get_total_linear_iterations () override
	Get the total number of linear iterations done in the last solve.

virtual unsigned	get_current_nonlinear_iteration_number () const override

void	set_residual_zero_out (bool state)
	Set if the residual should be zeroed out in the callback.

void	set_jacobian_zero_out (bool state)
	Set if the jacobian should be zeroed out in the callback.

void	use_default_monitor (bool state)
	Set to true to use the libMesh's default monitor, set to false to use your own.

void	set_snesmf_reuse_base (bool state)
	Set to true to let PETSc reuse the base vector.

bool	snes_mf_reuse_base () const

void	set_reproducible_residual (bool state)
	Set whether evaluating the residual twice at the same solution gives exactly the same result.

bool	reproducible_residual () const

void	set_computing_base_vector (bool computing_base_vector)
	Set whether we are computing the base vector for matrix-free finite-differencing.

bool	computing_base_vector () const

void	setup_default_monitor ()
	Setup the default monitor if required.

virtual bool	reuse_preconditioner () const override
	Getter for preconditioner reuse.

virtual unsigned int	reuse_preconditioner_max_linear_its () const override
	Getter for the maximum iterations flag for preconditioner reuse.

virtual void	force_new_preconditioner () override
	Immediately force a new preconditioner, even if reuse is set.

bool	initialized () const

const sys_type &	system () const

sys_type &	system ()

void	attach_preconditioner (Preconditioner< T > *preconditioner)
	Attaches a Preconditioner object to be used during the linear solves.

void	set_solver_configuration (SolverConfiguration &solver_configuration)
	Set the solver configuration object.

virtual void	set_reuse_preconditioner (bool reuse)
	Set the reuse preconditioner flag.

virtual void	set_reuse_preconditioner_max_linear_its (unsigned int i)
	Set the reuse_preconditioner_max_linear_its parameter.

virtual void	set_exact_constraint_enforcement (bool enable)
	Enable (or disable; it is `true` by default) exact enforcement of constraints at the solver level, correcting any constrained DoF coefficients in `current_local_solution` as well as applying nonlinear residual and Jacobian terms based on constraint equations.

bool	exact_constraint_enforcement ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static std::unique_ptr< NonlinearSolver< T > >	build (sys_type &s, const SolverPackage solver_package=libMesh::default_solver_package())
	Builds a `NonlinearSolver` using the nonlinear solver package specified by `solver_package`.

static std::string	get_info ()
	Gets a string containing the reference information.

static void	print_info (std::ostream &out_stream=libMesh::out)
	Prints the reference information, by default to `libMesh::out`.

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects.

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info().

static void	disable_print_counter_info ()

Public Attributes
std::unique_ptr< ComputeLineSearchObject >	linesearch_object
	A callable object that can be used to specify a custom line-search.

void(*	residual )(const NumericVector< Number > &X, NumericVector< Number > &R, sys_type &S)
	Function that computes the residual `R(X)` of the nonlinear system at the input iterate `X`.

NonlinearImplicitSystem::ComputeResidual *	residual_object
	Object that computes the residual `R(X)` of the nonlinear system at the input iterate `X`.

NonlinearImplicitSystem::ComputeResidual *	fd_residual_object
	Object that computes the residual `R(X)` of the nonlinear system at the input iterate `X` for the purpose of forming a finite-differenced Jacobian.

NonlinearImplicitSystem::ComputeResidual *	mffd_residual_object
	Object that computes the residual `R(X)` of the nonlinear system at the input iterate `X` for the purpose of forming Jacobian-vector products via finite differencing.

void(*	jacobian )(const NumericVector< Number > &X, SparseMatrix< Number > &J, sys_type &S)
	Function that computes the Jacobian `J(X)` of the nonlinear system at the input iterate `X`.

NonlinearImplicitSystem::ComputeJacobian *	jacobian_object
	Object that computes the Jacobian `J(X)` of the nonlinear system at the input iterate `X`.

void(*	matvec )(const NumericVector< Number > &X, NumericVector< Number > R, SparseMatrix< Number > J, sys_type &S)
	Function that computes either the residual \( R(X) \) or the Jacobian \( J(X) \) of the nonlinear system at the input iterate \( X \).

NonlinearImplicitSystem::ComputeResidualandJacobian *	residual_and_jacobian_object
	Object that computes either the residual \( R(X) \) or the Jacobian \( J(X) \) of the nonlinear system at the input iterate \( X \).

void(*	bounds )(NumericVector< Number > &XL, NumericVector< Number > &XU, sys_type &S)
	Function that computes the lower and upper bounds `XL` and `XU` on the solution of the nonlinear system.

NonlinearImplicitSystem::ComputeBounds *	bounds_object
	Object that computes the bounds vectors \( XL \) and \( XU \).

void(*	nullspace )(std::vector< NumericVector< Number > * > &sp, sys_type &S)
	Function that computes a basis for the Jacobian's nullspace – the kernel or the "zero energy modes" – that can be used in solving a degenerate problem iteratively, if the solver supports it (e.g., PETSc's KSP).

NonlinearImplicitSystem::ComputeVectorSubspace *	nullspace_object
	A callable object that computes a basis for the Jacobian's nullspace – the kernel or the "zero energy modes" – that can be used in solving a degenerate problem iteratively, if the solver supports it (e.g., PETSc's KSP).

void(*	transpose_nullspace )(std::vector< NumericVector< Number > * > &sp, sys_type &S)
	Function that computes a basis for the transpose Jacobian's nullspace – when solving a degenerate problem iteratively, if the solver supports it (e.g., PETSc's KSP), it is used to remove contributions outside of R(jac)

NonlinearImplicitSystem::ComputeVectorSubspace *	transpose_nullspace_object
	A callable object that computes a basis for the transpose Jacobian's nullspace – when solving a degenerate problem iteratively, if the solver supports it (e.g., PETSc's KSP), it is used to remove contributions outside of R(jac)

void(*	nearnullspace )(std::vector< NumericVector< Number > * > &sp, sys_type &S)
	Function that computes a basis for the Jacobian's near nullspace – the set of "low energy modes" – that can be used for AMG coarsening, if the solver supports it (e.g., ML, PETSc's GAMG).

NonlinearImplicitSystem::ComputeVectorSubspace *	nearnullspace_object
	A callable object that computes a basis for the Jacobian's near nullspace – the set of "low energy modes" – that can be used for AMG coarsening, if the solver supports it (e.g., ML, PETSc's GAMG).

void(*	user_presolve )(sys_type &S)
	Customizable function pointer which users can attach to the solver.

void(*	postcheck )(const NumericVector< Number > &old_soln, NumericVector< Number > &search_direction, NumericVector< Number > &new_soln, bool &changed_search_direction, bool &changed_new_soln, sys_type &S)
	Function that performs a "check" on the Newton search direction and solution after each nonlinear step.

NonlinearImplicitSystem::ComputePostCheck *	postcheck_object
	A callable object that is executed after each nonlinear iteration.

NonlinearImplicitSystem::ComputePreCheck *	precheck_object

unsigned int	max_nonlinear_iterations
	Maximum number of non-linear iterations.

unsigned int	max_function_evaluations
	Maximum number of function evaluations.

double	absolute_residual_tolerance
	The NonlinearSolver should exit after the residual is reduced to either less than absolute_residual_tolerance or less than relative_residual_tolerance times the initial residual.

double	relative_residual_tolerance

double	divergence_tolerance
	The NonlinearSolver should exit if the residual becomes greater than the initial residual times the divergence_tolerance.

double	absolute_step_tolerance
	The NonlinearSolver should exit after the full nonlinear step norm is reduced to either less than absolute_step_tolerance or less than relative_step_tolerance times the largest nonlinear solution which has been seen so far.

double	relative_step_tolerance

unsigned int	max_linear_iterations
	Each linear solver step should exit after `max_linear_iterations` is exceeded.

double	initial_linear_tolerance
	Any required linear solves will at first be done with this tolerance; the NonlinearSolver may tighten the tolerance for later solves.

double	minimum_linear_tolerance
	The tolerance for linear solves is kept above this minimum.

bool	converged
	After a call to solve this will reflect whether or not the nonlinear solve was successful.

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information.

Protected Member Functions
void	build_mat_null_space (NonlinearImplicitSystem::ComputeVectorSubspace computeSubspaceObject, void()(std::vector< NumericVector< Number > * > &, sys_type &), MatNullSpace *)

void	increment_constructor_count (const std::string &name) noexcept
	Increments the construction counter.

void	increment_destructor_count (const std::string &name) noexcept
	Increments the destruction counter.

Protected Attributes
WrappedPetsc< SNES >	_snes
	Nonlinear solver context.

SNESConvergedReason	_reason
	Store the reason for SNES convergence/divergence for use even after the _snes has been cleared.

PetscInt	_n_linear_iterations
	Stores the total number of linear iterations from the last solve.

unsigned	_current_nonlinear_iteration_number
	Stores the current nonlinear iteration number.

bool	_zero_out_residual
	true to zero out residual before going into application level call-back, otherwise false

bool	_zero_out_jacobian
	true to zero out jacobian before going into application level call-back, otherwise false

bool	_default_monitor
	true if we want the default monitor to be set, false for no monitor (i.e.

bool	_snesmf_reuse_base
	True, If we want the base vector to be used for differencing even if the function provided to SNESSetFunction() is not the same as that provided to MatMFFDSetFunction().

bool	_reproducible_residual
	Whether residual evaluation is reproducible.

bool	_computing_base_vector
	Whether we are computing the base vector for matrix-free finite differencing.

bool	_setup_reuse
	Whether we've triggered the preconditioner reuse.

PetscDMWrapper	_dm_wrapper
	Wrapper object for interacting with the "new" libMesh PETSc DM.

bool	_reuse_preconditioner
	Whether we should reuse the linear preconditioner.

bool	_exact_constraint_enforcement
	Whether we should enforce exact constraints globally during a solve.

unsigned int	_reuse_preconditioner_max_linear_its
	Number of linear iterations to retain the preconditioner.

sys_type &	_system
	A reference to the system we are solving.

bool	_is_initialized
	Flag indicating if the data structures have been initialized.

Preconditioner< T > *	_preconditioner
	Holds the Preconditioner object to be used for the linear solves.

SolverConfiguration *	_solver_configuration
	Optionally store a SolverOptions object that can be used to set parameters like solver type, tolerances and iteration limits.

const Parallel::Communicator &	_communicator

Static Protected Attributes
static Counts	_counts
	Actually holds the data.

static Threads::atomic< unsigned int >	_n_objects
	The number of objects.

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting.

static bool	_enable_print_counter = true
	Flag to control whether reference count information is printed when print_info is called.

Friends
ResidualContext	libmesh_petsc_snes_residual_helper (SNES snes, Vec x, void *ctx)

PetscErrorCode	libmesh_petsc_snes_residual (SNES snes, Vec x, Vec r, void *ctx)

PetscErrorCode	libmesh_petsc_snes_fd_residual (SNES snes, Vec x, Vec r, void *ctx)

PetscErrorCode	libmesh_petsc_snes_mffd_residual (SNES snes, Vec x, Vec r, void *ctx)

PetscErrorCode	libmesh_petsc_snes_jacobian (SNES snes, Vec x, Mat jac, Mat pc, void *ctx)

PetscErrorCode	libmesh_petsc_snes_precheck (SNESLineSearch, Vec X, Vec Y, PetscBool changed, void context)

Detailed Description

template<typename T>
class libMesh::PetscNonlinearSolver< T >

This class provides an interface to PETSc iterative solvers that is compatible with the libMesh NonlinearSolver<>

Author: Benjamin Kirk

Date: 2002-2007

Definition at line 73 of file petsc_nonlinear_solver.h.

Member Typedef Documentation

◆ Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 119 of file reference_counter.h.

◆ sys_type

template<typename T >

typedef NonlinearImplicitSystem libMesh::PetscNonlinearSolver< T >::sys_type

The type of system.

Definition at line 79 of file petsc_nonlinear_solver.h.

Constructor & Destructor Documentation

◆ PetscNonlinearSolver()

template<typename T >

libMesh::PetscNonlinearSolver< T >::PetscNonlinearSolver ( sys_type & system )

explicit

Constructor.

Initializes Petsc data structures

Definition at line 693 of file petsc_nonlinear_solver.C.

                                                                   :
  NonlinearSolver<T>(system_in),
  linesearch_object(nullptr),
  _reason(SNES_CONVERGED_ITERATING/*==0*/), // Arbitrary initial value...
  _n_linear_iterations(0),
  _current_nonlinear_iteration_number(0),
  _zero_out_residual(true),
  _zero_out_jacobian(true),
  _default_monitor(true),
  _snesmf_reuse_base(true),
  _reproducible_residual(true),
  _computing_base_vector(true),
  _setup_reuse(false)
{
}

◆ ~PetscNonlinearSolver()

template<typename T >

libMesh::PetscNonlinearSolver< T >::~PetscNonlinearSolver ( )

default

Destructor.

Member Function Documentation

◆ attach_preconditioner()

template<typename T >

void libMesh::NonlinearSolver< T >::attach_preconditioner ( Preconditioner< T > * preconditioner )

inherited

Attaches a Preconditioner object to be used during the linear solves.

Definition at line 74 of file nonlinear_solver.C.

{
  libmesh_error_msg_if(this->_is_initialized, "Preconditioner must be attached before the solver is initialized!");
 
  _preconditioner = preconditioner;
}

◆ build()

template<typename T >

std::unique_ptr< NonlinearSolver< T > > libMesh::NonlinearSolver< T >::build	(	sys_type &	s,
		const SolverPackage	solver_package = `libMesh::default_solver_package()`
	)

staticinherited

Builds a NonlinearSolver using the nonlinear solver package specified by solver_package.

Definition at line 40 of file nonlinear_solver.C.

{
  // Build the appropriate solver
  switch (solver_package)
    {
 
#ifdef LIBMESH_HAVE_PETSC
    case PETSC_SOLVERS:
      return std::make_unique<PetscNonlinearSolver<T>>(s);
#endif // LIBMESH_HAVE_PETSC
 
#if defined(LIBMESH_TRILINOS_HAVE_NOX) && defined(LIBMESH_TRILINOS_HAVE_EPETRA)
    case TRILINOS_SOLVERS:
      return std::make_unique<NoxNonlinearSolver<T>>(s);
#endif
 
    default:
      libmesh_error_msg("ERROR:  Unrecognized solver package: " << solver_package);
    }
}

References libMesh::PETSC_SOLVERS, and libMesh::TRILINOS_SOLVERS.

◆ build_mat_null_space()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::build_mat_null_space	(	NonlinearImplicitSystem::ComputeVectorSubspace *	computeSubspaceObject,
		void()(std::vector< NumericVector< Number > > &, sys_type &)	computeSubspace,
		MatNullSpace *	msp
	)

protected

Definition at line 852 of file petsc_nonlinear_solver.C.

{
  parallel_object_only();
 
  std::vector<NumericVector<Number> *> sp;
  if (computeSubspaceObject)
    (*computeSubspaceObject)(sp, this->system());
  else
    (*computeSubspace)(sp, this->system());
 
  *msp = LIBMESH_PETSC_NULLPTR;
  if (sp.size())
    {
      PetscInt nmodes = cast_int<PetscInt>(sp.size());
 
      std::vector<Vec> modes(nmodes);
      std::vector<PetscScalar> dots(nmodes);
 
      for (PetscInt i=0; i<nmodes; ++i)
        {
          auto pv = cast_ptr<PetscVector<T> *>(sp[i]);
 
          LibmeshPetscCall(VecDuplicate(pv->vec(), &modes[i]));
 
          LibmeshPetscCall(VecCopy(pv->vec(), modes[i]));
        }
 
      // Normalize.
      LibmeshPetscCall(VecNormalize(modes[0], LIBMESH_PETSC_NULLPTR));
 
      for (PetscInt i=1; i<nmodes; i++)
        {
          // Orthonormalize vec[i] against vec[0:i-1]
          LibmeshPetscCall(VecMDot(modes[i], i, modes.data(), dots.data()));
 
          for (PetscInt j=0; j<i; j++)
            dots[j] *= -1.;
 
          LibmeshPetscCall(VecMAXPY(modes[i], i, dots.data(), modes.data()));
 
          LibmeshPetscCall(VecNormalize(modes[i], LIBMESH_PETSC_NULLPTR));
        }
 
      LibmeshPetscCall(MatNullSpaceCreate(this->comm().get(), PETSC_FALSE, nmodes, modes.data(), msp));
 
      for (PetscInt i=0; i<nmodes; ++i)
        LibmeshPetscCall(VecDestroy(&modes[i]));
    }
}

◆ clear()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::clear ( )

overridevirtual

Release all memory and clear data structures.

Reimplemented from libMesh::NonlinearSolver< T >.

Definition at line 717 of file petsc_nonlinear_solver.C.

{
  if (this->initialized())
    {
      this->_is_initialized = false;
 
      // If we don't need the preconditioner next time
      // retain the original behavior of clearing the data
      // between solves.
      if (!(reuse_preconditioner()))
        {
        // SNESReset really ought to work but replacing destroy() with
        // SNESReset causes a very slight change in behavior that
        // manifests as two failed MOOSE tests...
        _snes.destroy();
        }
 
      // Reset the nonlinear iteration counter.  This information is only relevant
      // *during* the solve().  After the solve is completed it should return to
      // the default value of 0.
      _current_nonlinear_iteration_number = 0;
    }
}

References libMesh::initialized().

◆ comm()

const Parallel::Communicator & libMesh::ParallelObject::comm ( ) const

inlineinherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 97 of file parallel_object.h.

98 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition parallel_object.h:120

References libMesh::ParallelObject::_communicator.

◆ computing_base_vector()

template<typename T >

bool libMesh::PetscNonlinearSolver< T >::computing_base_vector ( ) const

inline

Returns: whether we are computing the base vector for matrix-free finite-differencing

Definition at line 210 of file petsc_nonlinear_solver.h.

210{ return _computing_base_vector; }

References libMesh::PetscNonlinearSolver< T >::_computing_base_vector.

Referenced by libMesh::PetscNonlinearSolver< T >::set_computing_base_vector().

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

{
  _enable_print_counter = false;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info().

Enabled by default.

Definition at line 94 of file reference_counter.C.

{
  _enable_print_counter = true;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ exact_constraint_enforcement()

template<typename T >

bool libMesh::NonlinearSolver< T >::exact_constraint_enforcement ( )

inlineinherited

Definition at line 418 of file nonlinear_solver.h.

  {
    return _exact_constraint_enforcement;
  }

References libMesh::NonlinearSolver< T >::_exact_constraint_enforcement.

◆ force_new_preconditioner()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::force_new_preconditioner ( )

overridevirtual

Immediately force a new preconditioner, even if reuse is set.

Reimplemented from libMesh::NonlinearSolver< T >.

Definition at line 1206 of file petsc_nonlinear_solver.C.

{
  // Easiest way is just to clear everything out
  this->_is_initialized = false;
  _snes.destroy();
  _setup_reuse = false;
}

◆ get_converged_reason()

template<typename T >

SNESConvergedReason libMesh::PetscNonlinearSolver< T >::get_converged_reason ( )

Returns: The currently-available (or most recently obtained, if the SNES object has been destroyed) convergence reason.

Refer to PETSc docs for the meaning of different SNESConvergedReasons.

Definition at line 1171 of file petsc_nonlinear_solver.C.

{
  if (this->initialized())
    LibmeshPetscCall(SNESGetConvergedReason(_snes, &_reason));
 
  return _reason;
}

References libMesh::initialized().

◆ get_current_nonlinear_iteration_number()

template<typename T >

virtual unsigned libMesh::PetscNonlinearSolver< T >::get_current_nonlinear_iteration_number ( ) const

inlineoverridevirtual

Returns: The current nonlinear iteration number if called during the solve(), for example by the user-specified residual or Jacobian function.

Implements libMesh::NonlinearSolver< T >.

Definition at line 157 of file petsc_nonlinear_solver.h.

158 { return _current_nonlinear_iteration_number; }

References libMesh::PetscNonlinearSolver< T >::_current_nonlinear_iteration_number.

◆ get_info()

std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

{
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
  std::ostringstream oss;
 
  oss << '\n'
      << " ---------------------------------------------------------------------------- \n"
      << "| Reference count information                                                |\n"
      << " ---------------------------------------------------------------------------- \n";
 
  for (const auto & [name, cd] : _counts)
    oss << "| " << name << " reference count information:\n"
        << "|  Creations:    " << cd.first    << '\n'
        << "|  Destructions: " << cd.second << '\n';
 
  oss << " ---------------------------------------------------------------------------- \n";
 
  return oss.str();
 
#else
 
  return "";
 
#endif
}

References libMesh::ReferenceCounter::_counts.

Referenced by libMesh::ReferenceCounter::print_info().

◆ get_total_linear_iterations()

template<typename T >

int libMesh::PetscNonlinearSolver< T >::get_total_linear_iterations ( )

overridevirtual

Get the total number of linear iterations done in the last solve.

Implements libMesh::NonlinearSolver< T >.

Definition at line 1180 of file petsc_nonlinear_solver.C.

{
  return _n_linear_iterations;
}

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

inlineprotectednoexceptinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 183 of file reference_counter.h.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.first++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_constructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), and libMesh::ReferenceCountedObject< T >::ReferenceCountedObject().

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

inlineprotectednoexceptinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 207 of file reference_counter.h.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.second++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_destructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::~ReferenceCountedObject().

◆ init()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::init ( const char * name = nullptr )

overridevirtual

Initialize data structures if not done so already.

May assign a name to the solver in some implementations

Implements libMesh::NonlinearSolver< T >.

Definition at line 742 of file petsc_nonlinear_solver.C.

{
  parallel_object_only();
 
  // Initialize the data structures if not done so already.
  if (!this->initialized())
    {
      this->_is_initialized = true;
 
      // Make only if we don't already have a retained snes
      // hanging around from the last solve
      if (!_snes)
        LibmeshPetscCall(SNESCreate(this->comm().get(), _snes.get()));
 
      // I believe all of the following can be safely repeated
      // even on an old snes instance from the last solve
 
      if (name)
        {
          libmesh_assert(std::string(name).front() != '-');
          libmesh_assert(std::string(name).back() == '_');
          LibmeshPetscCall(SNESSetOptionsPrefix(_snes, name));
        }
 
      // Attaching a DM to SNES.
#if defined(LIBMESH_ENABLE_AMR) && defined(LIBMESH_HAVE_METAPHYSICL)
      bool use_petsc_dm = libMesh::on_command_line(
          "--" + (name ? std::string(name) : std::string("")) + "use_petsc_dm");
 
      // This needs to be called before SNESSetFromOptions
      if (use_petsc_dm)
        this->_dm_wrapper.init_and_attach_petscdm(this->system(), _snes);
      else
#endif
      {
        WrappedPetsc<DM> dm;
        LibmeshPetscCall(DMCreate(this->comm().get(), dm.get()));
        LibmeshPetscCall(DMSetType(dm, DMLIBMESH));
        LibmeshPetscCall(DMlibMeshSetSystem(dm, this->system()));
 
        if (name)
          LibmeshPetscCall(DMSetOptionsPrefix(dm, name));
 
        LibmeshPetscCall(DMSetFromOptions(dm));
        LibmeshPetscCall(DMSetUp(dm));
        LibmeshPetscCall(SNESSetDM(_snes, dm));
        // SNES now owns the reference to dm.
      }
 
      setup_default_monitor();
 
      // If the SolverConfiguration object is provided, use it to set
      // options during solver initialization.
      if (this->_solver_configuration)
        {
          this->_solver_configuration->set_options_during_init();
        }
 
      if (this->_preconditioner)
        {
          KSP ksp;
          LibmeshPetscCall(SNESGetKSP (_snes, &ksp));
          PC pc;
          LibmeshPetscCall(KSPGetPC(ksp,&pc));
 
          this->_preconditioner->init();
 
          LibmeshPetscCall(PCSetType(pc, PCSHELL));
          LibmeshPetscCall(PCShellSetContext(pc,(void *)this->_preconditioner));
 
          //Re-Use the shell functions from petsc_linear_solver
          LibmeshPetscCall(PCShellSetSetUp(pc,libmesh_petsc_preconditioner_setup));
          LibmeshPetscCall(PCShellSetApply(pc,libmesh_petsc_preconditioner_apply));
        }
    }
 
 
  // Tell PETSc about our linesearch "post-check" function, but only
  // if the user has provided one.  There seem to be extra,
  // unnecessary residual calculations if a postcheck function is
  // attached for no reason.
  if (this->postcheck || this->postcheck_object)
    {
      SNESLineSearch linesearch;
      LibmeshPetscCall(SNESGetLineSearch(_snes, &linesearch));
 
      LibmeshPetscCall(SNESLineSearchSetPostCheck(linesearch, libmesh_petsc_snes_postcheck, this));
    }
 
  if (this->precheck_object)
    {
      SNESLineSearch linesearch;
      LibmeshPetscCall(SNESGetLineSearch(_snes, &linesearch));
 
      LibmeshPetscCall(SNESLineSearchSetPreCheck(linesearch, libmesh_petsc_snes_precheck, this));
    }
}

References DMlibMeshSetSystem(), libMesh::WrappedPetsc< T >::get(), libMesh::initialized(), libMesh::libmesh_assert(), libMesh::libmesh_petsc_preconditioner_apply(), libMesh::libmesh_petsc_preconditioner_setup(), libMesh::libmesh_petsc_snes_postcheck(), libMesh::libmesh_petsc_snes_precheck(), and libMesh::on_command_line().

◆ initialized()

template<typename T >

bool libMesh::NonlinearSolver< T >::initialized ( ) const

inlineinherited

Returns: true if the data structures are initialized, false otherwise.

Definition at line 83 of file nonlinear_solver.h.

83{ return _is_initialized; }

References libMesh::NonlinearSolver< T >::_is_initialized.

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 85 of file reference_counter.h.

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition reference_counter.h:132

References libMesh::ReferenceCounter::_n_objects.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 103 of file parallel_object.h.

  {
    processor_id_type returnval =
      cast_int<processor_id_type>(_communicator.size());
    libmesh_assert(returnval); // We never have an empty comm
    return returnval;
  }

References libMesh::ParallelObject::_communicator, libMesh::libmesh_assert(), and libMesh::Parallel::Communicator::size().

◆ print_converged_reason()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::print_converged_reason ( )

overridevirtual

Prints a useful message about why the latest nonlinear solve con(di)verged.

Reimplemented from libMesh::NonlinearSolver< T >.

Definition at line 1161 of file petsc_nonlinear_solver.C.

{
 
  libMesh::out << "Nonlinear solver convergence/divergence reason: "
               << SNESConvergedReasons[this->get_converged_reason()] << std::endl;
}

References libMesh::out.

◆ print_info()

void libMesh::ReferenceCounter::print_info ( std::ostream & out_stream = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

Definition at line 81 of file reference_counter.C.

{
  if (_enable_print_counter)
    out_stream << ReferenceCounter::get_info();
}

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

Referenced by libMesh::LibMeshInit::~LibMeshInit().

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 114 of file parallel_object.h.

115 { return cast_int<processor_id_type>(_communicator.rank()); }

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

◆ reproducible_residual()

template<typename T >

bool libMesh::PetscNonlinearSolver< T >::reproducible_residual ( ) const

inline

Returns: Whether evaluating the residual twice at the same solution gives exactly the same result

Definition at line 200 of file petsc_nonlinear_solver.h.

200{ return _reproducible_residual; }

References libMesh::PetscNonlinearSolver< T >::_reproducible_residual.

◆ reuse_preconditioner()

template<typename T >

bool libMesh::PetscNonlinearSolver< T >::reuse_preconditioner ( ) const

overridevirtual

Getter for preconditioner reuse.

Reimplemented from libMesh::NonlinearSolver< T >.

Definition at line 1194 of file petsc_nonlinear_solver.C.

{
  return this->_reuse_preconditioner;
}

◆ reuse_preconditioner_max_linear_its()

template<typename T >

unsigned int libMesh::PetscNonlinearSolver< T >::reuse_preconditioner_max_linear_its ( ) const

overridevirtual

Getter for the maximum iterations flag for preconditioner reuse.

Reimplemented from libMesh::NonlinearSolver< T >.

Definition at line 1200 of file petsc_nonlinear_solver.C.

{
  return this->_reuse_preconditioner_max_linear_its;
}

◆ set_computing_base_vector()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::set_computing_base_vector ( bool computing_base_vector )

inline

Set whether we are computing the base vector for matrix-free finite-differencing.

Definition at line 205 of file petsc_nonlinear_solver.h.

205{ _computing_base_vector = computing_base_vector; }

libMesh::PetscNonlinearSolver::computing_base_vector

bool computing_base_vector() const

Definition petsc_nonlinear_solver.h:210

References libMesh::PetscNonlinearSolver< T >::_computing_base_vector, and libMesh::PetscNonlinearSolver< T >::computing_base_vector().

◆ set_exact_constraint_enforcement()

template<typename T >

virtual void libMesh::NonlinearSolver< T >::set_exact_constraint_enforcement ( bool enable )

inlinevirtualinherited

Enable (or disable; it is true by default) exact enforcement of constraints at the solver level, correcting any constrained DoF coefficients in current_local_solution as well as applying nonlinear residual and Jacobian terms based on constraint equations.

This is probably only safe to disable if user code is setting nonlinear residual and Jacobian terms based on constraint equations at an element-by-element level, by combining the asymmetric_constraint_rows option with the residual_constrain_element_vector processing option in DofMap.

Definition at line 413 of file nonlinear_solver.h.

  {
    _exact_constraint_enforcement = enable;
  }

References libMesh::NonlinearSolver< T >::_exact_constraint_enforcement.

◆ set_jacobian_zero_out()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::set_jacobian_zero_out ( bool state )

inline

Set if the jacobian should be zeroed out in the callback.

Definition at line 168 of file petsc_nonlinear_solver.h.

168{ _zero_out_jacobian = state; }

References libMesh::PetscNonlinearSolver< T >::_zero_out_jacobian.

◆ set_reproducible_residual()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::set_reproducible_residual ( bool state )

inline

Set whether evaluating the residual twice at the same solution gives exactly the same result.

This is used to decide whether to run the debug-mode check of matrix-free base vector reuse, which requires an exact match. The check is already skipped for MPI-parallel and threaded runs; applications whose assembly is non-deterministic for other reasons (e.g. due to device parallelism) should set this to false. This only disables the check; the base vector is still reused.

Definition at line 194 of file petsc_nonlinear_solver.h.

194{ _reproducible_residual = state; }

References libMesh::PetscNonlinearSolver< T >::_reproducible_residual.

◆ set_residual_zero_out()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::set_residual_zero_out ( bool state )

inline

Set if the residual should be zeroed out in the callback.

Definition at line 163 of file petsc_nonlinear_solver.h.

163{ _zero_out_residual = state; }

References libMesh::PetscNonlinearSolver< T >::_zero_out_residual.

◆ set_reuse_preconditioner()

template<typename T >

void libMesh::NonlinearSolver< T >::set_reuse_preconditioner ( bool reuse )

virtualinherited

Set the reuse preconditioner flag.

Definition at line 94 of file nonlinear_solver.C.

{
  _reuse_preconditioner = reuse;
}

◆ set_reuse_preconditioner_max_linear_its()

template<typename T >

void libMesh::NonlinearSolver< T >::set_reuse_preconditioner_max_linear_its ( unsigned int i )

virtualinherited

Set the reuse_preconditioner_max_linear_its parameter.

Definition at line 106 of file nonlinear_solver.C.

{
  _reuse_preconditioner_max_linear_its = i;
}

◆ set_snesmf_reuse_base()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::set_snesmf_reuse_base ( bool state )

inline

Set to true to let PETSc reuse the base vector.

Definition at line 178 of file petsc_nonlinear_solver.h.

178{ _snesmf_reuse_base = state; }

References libMesh::PetscNonlinearSolver< T >::_snesmf_reuse_base.

◆ set_solver_configuration()

template<typename T >

void libMesh::NonlinearSolver< T >::set_solver_configuration ( SolverConfiguration & solver_configuration )

inherited

Set the solver configuration object.

Definition at line 82 of file nonlinear_solver.C.

{
  _solver_configuration = &solver_configuration;
}

◆ setup_default_monitor()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::setup_default_monitor ( )

Setup the default monitor if required.

Definition at line 1186 of file petsc_nonlinear_solver.C.

{
  if (_default_monitor)
    LibmeshPetscCall(
      SNESMonitorSet(_snes, libmesh_petsc_snes_monitor, this, LIBMESH_PETSC_NULLPTR));
}

References libMesh::libmesh_petsc_snes_monitor().

◆ snes()

template<typename T >

SNES libMesh::PetscNonlinearSolver< T >::snes ( const char * name = nullptr )

Returns: The raw PETSc snes context pointer. This method calls init() so in that vein, we have an optional name prefix argument that if provided will be given to the SNES context

Definition at line 842 of file petsc_nonlinear_solver.C.

{
  this->init(name);
  return _snes;
}

◆ snes_mf_reuse_base()

template<typename T >

bool libMesh::PetscNonlinearSolver< T >::snes_mf_reuse_base ( ) const

inline

Returns: Whether we are reusing the nonlinear function evaluation as the base for doing matrix-free approximation of the Jacobian action

Definition at line 184 of file petsc_nonlinear_solver.h.

184{ return _snesmf_reuse_base; }

References libMesh::PetscNonlinearSolver< T >::_snesmf_reuse_base.

◆ solve() [1/2]

template<typename T >

std::pair< unsigned int, Real > libMesh::PetscNonlinearSolver< T >::solve	(	SparseMatrix< T > &	jac_in,
		SparseMatrix< T > &	pre_in,
		NumericVector< T > &	x_in,
		NumericVector< T > &	r_in,
		const double	,
		const unsigned int
	)

overridevirtual

Call the Petsc solver, using jac_in as the actual SNES Jacobian operator (Amat) and pre_in as the preconditioning matrix (Pmat).

Reimplemented from libMesh::NonlinearSolver< T >.

Definition at line 917 of file petsc_nonlinear_solver.C.

{
  parallel_object_only();
 
  LOG_SCOPE("solve()", "PetscNonlinearSolver");
  this->init ();
 
  // Make sure the data passed in are really of Petsc types
  PetscMatrixBase<T> * jac = cast_ptr<PetscMatrixBase<T> *>(&jac_in);
  PetscMatrixBase<T> * pre = cast_ptr<PetscMatrixBase<T> *>(&pre_in);
  PetscVector<T> * x   = cast_ptr<PetscVector<T> *>(&x_in);
  PetscVector<T> * r   = cast_ptr<PetscVector<T> *>(&r_in);
 
  PetscInt n_iterations =0;
  // Should actually be a PetscReal, but I don't know which version of PETSc first introduced PetscReal
  Real final_residual_norm=0.;
 
  // We don't want to do this twice because it resets
  // SNESSetLagPreconditioner
  if ((reuse_preconditioner()) && (!_setup_reuse))
    {
      _setup_reuse = true;
      LibmeshPetscCall(SNESSetLagPreconditionerPersists(_snes, PETSC_TRUE));
      // According to the PETSC 3.16.5 docs -2 is a magic number which
      // means "recalculate the next time you need it and then not again"
      LibmeshPetscCall(SNESSetLagPreconditioner(_snes, -2));
      // Add in our callback which will trigger recalculating
      // the preconditioner when we hit reuse_preconditioner_max_linear_its
      LibmeshPetscCall(SNESMonitorSet(_snes, &libmesh_petsc_recalculate_monitor,
                                      this,
                                      NULL));
    }
  else if (!(reuse_preconditioner()))
    // This covers the case where it was enabled but was then disabled
    {
      LibmeshPetscCall(SNESSetLagPreconditionerPersists(_snes, PETSC_FALSE));
      if (_setup_reuse)
        {
          _setup_reuse = false;
          LibmeshPetscCall(SNESMonitorCancel(_snes));
          // Readd default monitor
          setup_default_monitor();
        }
    }
 
  LibmeshPetscCall(SNESSetFunction (_snes, r->vec(), libmesh_petsc_snes_residual, this));
 
  // Only set the jacobian function if we've been provided with something to call.
  // This allows a user to set their own jacobian function if they want to
  if (this->jacobian || this->jacobian_object || this->residual_and_jacobian_object)
    LibmeshPetscCall(SNESSetJacobian (_snes, jac->mat(), pre->mat(), libmesh_petsc_snes_jacobian, this));
 
  // Have the Krylov subspace method use our good initial guess rather than 0
  KSP ksp;
  LibmeshPetscCall(SNESGetKSP (_snes, &ksp));
 
  // Set the tolerances for the iterative solver.  Use the user-supplied
  // tolerance for the relative residual & leave the others at default values
  LibmeshPetscCall(KSPSetTolerances (ksp, this->initial_linear_tolerance, PETSC_DEFAULT,
                                     PETSC_DEFAULT, this->max_linear_iterations));
 
  // Set the tolerances for the non-linear solver.
  LibmeshPetscCall(SNESSetTolerances(_snes,
                                     this->absolute_residual_tolerance,
                                     this->relative_residual_tolerance,
                                     this->relative_step_tolerance,
                                     this->max_nonlinear_iterations,
                                     this->max_function_evaluations));
 
  // Not supported by PETSc
  if (this->absolute_step_tolerance != 0) // 0 is default value, both in MOOSE and libMesh
    libmesh_warning("Setting the absolute step tolerance is not supported with the PETSc nonlinear solver.");
 
  // Set the divergence tolerance for the non-linear solver
#if !PETSC_VERSION_LESS_THAN(3,8,0)
  LibmeshPetscCall(SNESSetDivergenceTolerance(_snes, this->divergence_tolerance));
#endif
 
  //Pull in command-line options
#if PETSC_VERSION_LESS_THAN(3,7,0)
  LibmeshPetscCall(KSPSetFromOptions(ksp));
#endif
  LibmeshPetscCall(SNESSetFromOptions(_snes));
 
  PC pc;
  LibmeshPetscCall(KSPGetPC(ksp, &pc));
  PetscPreconditioner<T>::set_petsc_aux_data(pc, this->system());
 
#if defined(LIBMESH_HAVE_PETSC_HYPRE) && PETSC_VERSION_LESS_THAN(3, 23, 0) &&                      \
    !PETSC_VERSION_LESS_THAN(3, 12, 0) && defined(PETSC_HAVE_HYPRE_DEVICE)
  {
    // Make sure hypre has been initialized
    LibmeshPetscCallExternal(HYPRE_Initialize);
    PetscScalar * dummyarray;
    PetscMemType mtype;
    LibmeshPetscCall(VecGetArrayAndMemType(x->vec(), &dummyarray, &mtype));
    LibmeshPetscCall(VecRestoreArrayAndMemType(x->vec(), &dummyarray));
    if (PetscMemTypeHost(mtype))
      LibmeshPetscCallExternal(HYPRE_SetMemoryLocation, HYPRE_MEMORY_HOST);
  }
#endif
 
  if (this->user_presolve)
    this->user_presolve(this->system());
 
  //Set the preconditioning matrix
  if (this->_preconditioner)
    {
      this->_preconditioner->set_matrix(pre_in);
      this->_preconditioner->init();
    }
 
  // If the SolverConfiguration object is provided, use it to override
  // solver options.
  if (this->_solver_configuration)
    this->_solver_configuration->configure_solver();
 
  // In PETSc versions before 3.5.0, it is not possible to call
  // SNESSetUp() before the solution and rhs vectors are initialized, as
  // this triggers the
  //
  // "Solution vector cannot be right hand side vector!"
  //
  // error message. It is also not possible to call SNESSetSolution()
  // in those versions of PETSc to work around the problem, since that
  // API was removed in 3.0.0 and only restored in 3.6.0. The
  // overzealous check was moved out of SNESSetUp in PETSc 3.5.0
  // (petsc/petsc@154060b), so this code block should be safe to use
  // in 3.5.0 and later.
#if !PETSC_VERSION_LESS_THAN(3,6,0)
  LibmeshPetscCall(SNESSetSolution(_snes, x->vec()));
#endif
  LibmeshPetscCall(SNESSetUp(_snes));
 
  Mat J, P;
  LibmeshPetscCall(SNESGetJacobian(_snes, &J, &P,
                                   LIBMESH_PETSC_NULLPTR,
                                   LIBMESH_PETSC_NULLPTR));
  LibmeshPetscCall(MatMFFDSetFunction(J, libmesh_petsc_snes_mffd_interface, this));
#if !PETSC_VERSION_LESS_THAN(3,8,4)
#ifndef NDEBUG
  // If we're in debug mode, do not reuse the nonlinear function evaluation as the base for doing
  // matrix-free approximations of the Jacobian action. Instead if the user requested that we reuse
  // the base, we'll check the base function evaluation and compare it to the nonlinear residual
  // evaluation. If they are different, then we'll error and inform the user that it's unsafe to
  // reuse the base
  LibmeshPetscCall(MatSNESMFSetReuseBase(J, PETSC_FALSE));
#else
  // Resue the residual vector from SNES
  LibmeshPetscCall(MatSNESMFSetReuseBase(J, static_cast<PetscBool>(_snesmf_reuse_base)));
#endif
#endif
 
  // Only set the nullspace if we have a way of computing it and the result is non-empty.
  if (this->nullspace || this->nullspace_object)
    {
      WrappedPetsc<MatNullSpace> msp;
      this->build_mat_null_space(this->nullspace_object, this->nullspace, msp.get());
      if (msp)
        {
          LibmeshPetscCall(MatSetNullSpace(J, msp));
          if (P != J)
            LibmeshPetscCall(MatSetNullSpace(P, msp));
        }
    }
 
  // Only set the transpose nullspace if we have a way of computing it and the result is non-empty.
  if (this->transpose_nullspace || this->transpose_nullspace_object)
    {
#if PETSC_VERSION_LESS_THAN(3,6,0)
      libmesh_warning("MatSetTransposeNullSpace is only supported for PETSc >= 3.6, transpose nullspace will be ignored.");
#else
      WrappedPetsc<MatNullSpace> msp;
      this->build_mat_null_space(this->transpose_nullspace_object, this->transpose_nullspace, msp.get());
      if (msp)
        {
          LibmeshPetscCall(MatSetTransposeNullSpace(J, msp));
          if (P != J)
            LibmeshPetscCall(MatSetTransposeNullSpace(P, msp));
        }
#endif
    }
 
  // Only set the nearnullspace if we have a way of computing it and the result is non-empty.
  if (this->nearnullspace || this->nearnullspace_object)
    {
      WrappedPetsc<MatNullSpace> msp;
      this->build_mat_null_space(this->nearnullspace_object, this->nearnullspace, msp.get());
 
      if (msp)
        {
          LibmeshPetscCall(MatSetNearNullSpace(J, msp));
          if (P != J)
            LibmeshPetscCall(MatSetNearNullSpace(P, msp));
        }
    }
 
  SNESLineSearch linesearch;
  if (linesearch_object)
  {
    LibmeshPetscCall(SNESGetLineSearch(_snes, &linesearch));
    LibmeshPetscCall(SNESLineSearchSetType(linesearch, SNESLINESEARCHSHELL));
#if PETSC_RELEASE_GREATER_EQUALS(3, 21, 0)
    LibmeshPetscCall(SNESLineSearchShellSetApply(linesearch, libmesh_petsc_linesearch_shellfunc, this));
#else
    LibmeshPetscCall(SNESLineSearchShellSetUserFunc(linesearch, libmesh_petsc_linesearch_shellfunc, this));
#endif
  }
 
  LibmeshPetscCall(SNESSolve (_snes, LIBMESH_PETSC_NULLPTR, x->vec()));
 
  LibmeshPetscCall(SNESGetIterationNumber(_snes, &n_iterations));
 
  LibmeshPetscCall(SNESGetLinearSolveIterations(_snes, &_n_linear_iterations));
 
  // SNESGetFunction has been around forever and should work on all
  // versions of PETSc.  This is also now the recommended approach
  // according to the documentation for the PETSc 3.5.1 release:
  // http://www.mcs.anl.gov/petsc/documentation/changes/35.html
  Vec f;
  LibmeshPetscCall(SNESGetFunction(_snes, &f, 0, 0));
  LibmeshPetscCall(VecNorm(f, NORM_2, pPR(&final_residual_norm)));
 
  // Get and store the reason for convergence
  LibmeshPetscCall(SNESGetConvergedReason(_snes, &_reason));
 
  //Based on Petsc 2.3.3 documentation all diverged reasons are negative
  this->converged = (_reason >= 0);
 
  // Reset data structure
  this->clear();
 
  // return the # of its. and the final residual norm.
  return std::make_pair(n_iterations, final_residual_norm);
}

References libMesh::WrappedPetsc< T >::get(), libMesh::libmesh_petsc_linesearch_shellfunc(), libMesh::libmesh_petsc_recalculate_monitor(), libMesh::libmesh_petsc_snes_jacobian(), libMesh::libmesh_petsc_snes_mffd_interface(), libMesh::libmesh_petsc_snes_residual(), libMesh::PetscMatrixBase< T >::mat(), libMesh::pPR(), libMesh::Real, and libMesh::PetscPreconditioner< T >::set_petsc_aux_data().

◆ solve() [2/2]

template<typename T >

std::pair< unsigned int, Real > libMesh::PetscNonlinearSolver< T >::solve	(	SparseMatrix< T > &	pre_in,
		NumericVector< T > &	x_in,
		NumericVector< T > &	r_in,
		const double	tol,
		const unsigned int	m_its
	)

overridevirtual

Call the Petsc solver, using the same matrix for the system and preconditioner matrices.

Calls the two-matrix overload below with pre_in for both.

Implements libMesh::NonlinearSolver< T >.

Definition at line 906 of file petsc_nonlinear_solver.C.

{
  return this->solve(pre_in, pre_in, x_in, r_in, tol, m_its);
}

◆ system() [1/2]

template<typename T >

sys_type & libMesh::NonlinearSolver< T >::system ( )

inlineinherited

Returns: A writable reference to the system we are solving.

Definition at line 293 of file nonlinear_solver.h.

293{ return _system; }

libMesh::NonlinearSolver::_system

sys_type & _system

A reference to the system we are solving.

Definition nonlinear_solver.h:443

References libMesh::NonlinearSolver< T >::_system.

◆ system() [2/2]

template<typename T >

const sys_type & libMesh::NonlinearSolver< T >::system ( ) const

inlineinherited

Returns: A constant reference to the system we are solving.

Definition at line 288 of file nonlinear_solver.h.

288{ return _system; }

References libMesh::NonlinearSolver< T >::_system.

Referenced by libMesh::Problem_Interface::computeJacobian(), libMesh::Problem_Interface::computePreconditioner(), libMesh::libmesh_petsc_snes_postcheck(), and libMesh::NoxNonlinearSolver< Number >::solve().

◆ use_default_monitor()

template<typename T >

void libMesh::PetscNonlinearSolver< T >::use_default_monitor ( bool state )

inline

Set to true to use the libMesh's default monitor, set to false to use your own.

Definition at line 173 of file petsc_nonlinear_solver.h.

173{ _default_monitor = state; }

References libMesh::PetscNonlinearSolver< T >::_default_monitor.

Friends And Related Symbol Documentation

◆ libmesh_petsc_snes_fd_residual

template<typename T >

PetscErrorCode libmesh_petsc_snes_fd_residual	(	SNES	snes,
		Vec	x,
		Vec	r,
		void *	ctx
	)

friend

Definition at line 232 of file petsc_nonlinear_solver.C.

  {
    PetscFunctionBegin;
 
    ResidualContext rc = libmesh_petsc_snes_residual_helper(snes, x, ctx);
 
    libmesh_parallel_only(rc.sys.comm());
 
    libmesh_assert(r);
    PetscVector<Number> R(r, rc.sys.comm());
 
    if (rc.solver->_zero_out_residual)
      R.zero();
 
    if (rc.solver->fd_residual_object != nullptr)
      rc.solver->fd_residual_object->residual(*rc.sys.current_local_solution.get(), R, rc.sys);
 
    else if (rc.solver->residual_object != nullptr)
      rc.solver->residual_object->residual(*rc.sys.current_local_solution.get(), R, rc.sys);
 
    else
      libmesh_error_msg("Error! Unable to compute residual for forming finite difference Jacobian!");
 
    // Synchronize PETSc x to local solution since the local solution may be changed due to the constraints
    PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(rc.sys.solution.get());
    PetscVector<Number> X_global(x, rc.sys.comm());
 
    X_global.swap(X_sys);
    rc.sys.update();
    X_global.swap(X_sys);
 
    R.close();
 
    if (rc.solver->_exact_constraint_enforcement)
      {
        rc.sys.get_dof_map().enforce_constraints_on_residual(rc.sys, &R, rc.sys.current_local_solution.get(), /*homogeneous=*/false);
        R.close();
      }
 
    PetscFunctionReturn(LIBMESH_PETSC_SUCCESS);
  }

◆ libmesh_petsc_snes_jacobian

template<typename T >

PetscErrorCode libmesh_petsc_snes_jacobian	(	SNES	snes,
		Vec	x,
		Mat	jac,
		Mat	pc,
		void *	ctx
	)

friend

Definition at line 404 of file petsc_nonlinear_solver.C.

  {
    PetscFunctionBegin;
 
    LOG_SCOPE("jacobian()", "PetscNonlinearSolver");
 
    libmesh_assert(ctx);
 
    // No way to safety-check this cast, since we got a void *...
    PetscNonlinearSolver<Number> * solver =
      static_cast<PetscNonlinearSolver<Number> *> (ctx);
 
    libmesh_parallel_only(solver->comm());
 
    // Get the current iteration number from the snes object,
    // store it in the PetscNonlinearSolver object for possible use
    // by the user's Jacobian function.
    {
      PetscInt n_iterations = 0;
      LibmeshPetscCall2(solver->comm(), SNESGetIterationNumber(snes, &n_iterations));
      solver->_current_nonlinear_iteration_number = cast_int<unsigned>(n_iterations);
    }
 
    //-----------------------------------------------------------------------------
    // if the user has provided both function pointers and objects only the pointer
    // will be used, so catch that as an error
    libmesh_error_msg_if(solver->jacobian && solver->jacobian_object,
                         "ERROR: cannot specify both a function and object to compute the Jacobian!");
 
    libmesh_error_msg_if(solver->matvec && solver->residual_and_jacobian_object,
                         "ERROR: cannot specify both a function and object to compute the combined Residual & Jacobian!");
 
    NonlinearImplicitSystem & sys = solver->system();
 
    PetscMatrixBase<Number> * const PC = pc ? PetscMatrixBase<Number>::get_context(pc, sys.comm()) : nullptr;
    PetscMatrixBase<Number> * Jac = jac ? PetscMatrixBase<Number>::get_context(jac, sys.comm()) : nullptr;
    PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
    PetscVector<Number> X_global(x, sys.comm());
 
    PetscMFFDMatrix<Number> mffd_jac(sys.comm());
    PetscBool p_is_shell = PETSC_FALSE;
    PetscBool j_is_mffd = PETSC_FALSE;
    PetscBool j_is_shell = PETSC_FALSE;
    if (pc)
      LibmeshPetscCall2(sys.comm(), PetscObjectTypeCompare((PetscObject)pc, MATSHELL, &p_is_shell));
    libmesh_assert(jac);
    LibmeshPetscCall2(sys.comm(), PetscObjectTypeCompare((PetscObject)jac, MATMFFD, &j_is_mffd));
    LibmeshPetscCall2(sys.comm(), PetscObjectTypeCompare((PetscObject)jac, MATSHELL, &j_is_shell));
    if (j_is_mffd == PETSC_TRUE)
      {
        libmesh_assert(!Jac);
        Jac = &mffd_jac;
        // mffd_jac is function-local, so don't attach a context to jac here -- it would
        // dangle once mffd_jac is destroyed at the end of this call.
        mffd_jac.assign(jac, /*set_context=*/false);
      }
 
    // We already computed the Jacobian during the residual evaluation
    if (solver->residual_and_jacobian_object)
    {
      // We could be doing matrix-free in which case we cannot rely on closing of explicit matrices
      // that occurs during the PETSc residual callback
      if ((j_is_shell == PETSC_TRUE) || (j_is_mffd == PETSC_TRUE))
        Jac->close();
 
      if (pc && (p_is_shell == PETSC_TRUE))
        PC->close();
 
      PetscFunctionReturn(LIBMESH_PETSC_SUCCESS);
    }
 
    // Set the dof maps
    PC->attach_dof_map(sys.get_dof_map());
    Jac->attach_dof_map(sys.get_dof_map());
 
    // Use the systems update() to get a good local version of the parallel solution
    X_global.swap(X_sys);
    sys.update();
    X_global.swap(X_sys);
 
    // Enforce constraints (if any) exactly on the
    // current_local_solution.  This is the solution vector that is
    // actually used in the computation of the residual below, and is
    // not locked by debug-enabled PETSc the way that "x" is.
    if (solver->_exact_constraint_enforcement)
      sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
 
    if (solver->_zero_out_jacobian)
      PC->zero();
 
 
    if (solver->jacobian != nullptr)
      solver->jacobian(*sys.current_local_solution.get(), *PC, sys);
 
    else if (solver->jacobian_object != nullptr)
      solver->jacobian_object->jacobian(*sys.current_local_solution.get(), *PC, sys);
 
    else if (solver->matvec != nullptr)
      solver->matvec(*sys.current_local_solution.get(), nullptr, PC, sys);
 
    else
      libmesh_error_msg("Error! Unable to compute residual and/or Jacobian!");
 
    PC->close();
    if (solver->_exact_constraint_enforcement)
      {
        sys.get_dof_map().enforce_constraints_on_jacobian(sys, PC);
        PC->close();
      }
 
    if (Jac != PC)
      {
        // Assume that shells know what they're doing
        libmesh_assert(!solver->_exact_constraint_enforcement || (j_is_mffd == PETSC_TRUE) ||
                       (j_is_shell == PETSC_TRUE));
        Jac->close();
      }
 
    PetscFunctionReturn(LIBMESH_PETSC_SUCCESS);
  }

◆ libmesh_petsc_snes_mffd_residual

template<typename T >

PetscErrorCode libmesh_petsc_snes_mffd_residual	(	SNES	snes,
		Vec	x,
		Vec	r,
		void *	ctx
	)

friend

Definition at line 278 of file petsc_nonlinear_solver.C.

  {
    PetscFunctionBegin;
 
    ResidualContext rc = libmesh_petsc_snes_residual_helper(snes, x, ctx);
 
    libmesh_parallel_only(rc.sys.comm());
 
    libmesh_assert(r);
    PetscVector<Number> R(r, rc.sys.comm());
 
    if (rc.solver->_zero_out_residual)
      R.zero();
 
    if (rc.solver->mffd_residual_object != nullptr)
      rc.solver->mffd_residual_object->residual(*rc.sys.current_local_solution.get(), R, rc.sys);
 
    else if (rc.solver->residual_object != nullptr)
      rc.solver->residual_object->residual(*rc.sys.current_local_solution.get(), R, rc.sys);
 
    else
      libmesh_error_msg("Error! Unable to compute residual for forming finite differenced"
                        "Jacobian-vector products!");
 
    // Synchronize PETSc x to local solution since the local solution may be changed due to the constraints
    PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(rc.sys.solution.get());
    PetscVector<Number> X_global(x, rc.sys.comm());
 
    X_global.swap(X_sys);
    rc.sys.update();
    X_global.swap(X_sys);
 
    R.close();
 
    if (rc.solver->_exact_constraint_enforcement)
      {
        rc.sys.get_dof_map().enforce_constraints_on_residual(rc.sys, &R, rc.sys.current_local_solution.get(), /*homogeneous=*/false);
        R.close();
      }
 
    PetscFunctionReturn(LIBMESH_PETSC_SUCCESS);
  }

◆ libmesh_petsc_snes_precheck

template<typename T >

PetscErrorCode libmesh_petsc_snes_precheck	(	SNESLineSearch	,
		Vec	X,
		Vec	Y,
		PetscBool *	changed,
		void *	context
	)

friend

Definition at line 627 of file petsc_nonlinear_solver.C.

  {
    PetscFunctionBegin;
 
    LOG_SCOPE("precheck()", "PetscNonlinearSolver");
 
    // PETSc almost certainly initializes these to false already, but
    // it doesn't hurt to be explicit.
    *changed = PETSC_FALSE;
 
    libmesh_assert(context);
 
    // Cast the context to a NonlinearSolver object.
    PetscNonlinearSolver<Number> * solver =
      static_cast<PetscNonlinearSolver<Number> *> (context);
 
    libmesh_parallel_only(solver->comm());
 
    // It's possible that we don't need to do anything at all, in
    // that case return early...
    if (!solver->precheck_object)
      PetscFunctionReturn(LIBMESH_PETSC_SUCCESS);
 
    // The user sets these flags in his/her postcheck function to
    // indicate whether they changed something.
    bool
      petsc_changed = false;
 
    auto & sys = solver->system();
    auto & x_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
    PetscVector<Number> petsc_x(X, sys.comm());
    PetscVector<Number> petsc_y(Y, sys.comm());
 
    // Use the systems update() to get a good local version of the parallel solution
    petsc_x.swap(x_sys);
    sys.update();
    petsc_x.swap(x_sys);
 
    // Enforce constraints (if any) exactly on the
    // current_local_solution.  This is the solution vector that is
    // actually used in the computation of residuals and Jacobians, and is
    // not locked by debug-enabled PETSc the way that "x" is.
    libmesh_assert(sys.current_local_solution.get());
    auto & local_soln = *sys.current_local_solution.get();
    if (solver->_exact_constraint_enforcement)
      sys.get_dof_map().enforce_constraints_exactly(sys, &local_soln);
 
    solver->precheck_object->precheck(local_soln,
                                      petsc_y,
                                      petsc_changed,
                                      sys);
 
    // Record whether the user changed the solution or the search direction.
    if (petsc_changed)
      *changed = PETSC_TRUE;
 
    PetscFunctionReturn(LIBMESH_PETSC_SUCCESS);
  }

◆ libmesh_petsc_snes_residual

template<typename T >

PetscErrorCode libmesh_petsc_snes_residual	(	SNES	snes,
		Vec	x,
		Vec	r,
		void *	ctx
	)

friend

Definition at line 156 of file petsc_nonlinear_solver.C.

  {
    PetscFunctionBegin;
 
    ResidualContext rc = libmesh_petsc_snes_residual_helper(snes, x, ctx);
 
    libmesh_parallel_only(rc.sys.comm());
 
    libmesh_assert(r);
    PetscVector<Number> R(r, rc.sys.comm());
 
    if (rc.solver->_zero_out_residual)
      R.zero();
 
    //-----------------------------------------------------------------------------
    // if the user has provided both function pointers and objects only the pointer
    // will be used, so catch that as an error
    libmesh_error_msg_if(rc.solver->residual && rc.solver->residual_object,
                         "ERROR: cannot specify both a function and object to compute the Residual!");
 
    libmesh_error_msg_if(rc.solver->matvec && rc.solver->residual_and_jacobian_object,
                         "ERROR: cannot specify both a function and object to compute the combined Residual & Jacobian!");
 
    if (rc.solver->residual != nullptr)
      rc.solver->residual(*rc.sys.current_local_solution.get(), R, rc.sys);
 
    else if (rc.solver->residual_object != nullptr)
      rc.solver->residual_object->residual(*rc.sys.current_local_solution.get(), R, rc.sys);
 
    else if (rc.solver->matvec != nullptr)
      rc.solver->matvec (*rc.sys.current_local_solution.get(), &R, nullptr, rc.sys);
 
    else if (rc.solver->residual_and_jacobian_object != nullptr)
    {
      auto & jac = rc.sys.get_system_matrix();
 
      if (rc.solver->_zero_out_jacobian)
        jac.zero();
 
      rc.solver->residual_and_jacobian_object->residual_and_jacobian(
          *rc.sys.current_local_solution.get(), &R, &jac, rc.sys);
 
      jac.close();
      if (rc.solver->_exact_constraint_enforcement)
        {
          rc.sys.get_dof_map().enforce_constraints_on_jacobian(rc.sys, &jac);
          jac.close();
        }
    }
 
    else
      libmesh_error_msg("Error! Unable to compute residual and/or Jacobian!");
 
 
    // Synchronize PETSc x to local solution since the local solution may be changed due to the constraints
    PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(rc.sys.solution.get());
    PetscVector<Number> X_global(x, rc.sys.comm());
 
    X_global.swap(X_sys);
    rc.sys.update();
    X_global.swap(X_sys);
 
    R.close();
 
    if (rc.solver->_exact_constraint_enforcement)
      {
        rc.sys.get_dof_map().enforce_constraints_on_residual(rc.sys, &R, rc.sys.current_local_solution.get(), /*homogeneous=*/false);
        R.close();
      }
 
    PetscFunctionReturn(LIBMESH_PETSC_SUCCESS);
  }

◆ libmesh_petsc_snes_residual_helper

template<typename T >

ResidualContext libmesh_petsc_snes_residual_helper	(	SNES	snes,
		Vec	x,
		void *	ctx
	)

friend

Definition at line 57 of file petsc_nonlinear_solver.C.

{
  LOG_SCOPE("residual()", "PetscNonlinearSolver");
 
  libmesh_assert(x);
  libmesh_assert(ctx);
 
  // No way to safety-check this cast, since we got a void *...
  PetscNonlinearSolver<Number> * solver =
    static_cast<PetscNonlinearSolver<Number> *> (ctx);
 
  libmesh_parallel_only(solver->comm());
 
  // Get the current iteration number from the snes object,
  // store it in the PetscNonlinearSolver object for possible use
  // by the user's residual function.
  {
    PetscInt n_iterations = 0;
    LibmeshPetscCall2(solver->comm(), SNESGetIterationNumber(snes, &n_iterations));
    solver->_current_nonlinear_iteration_number = cast_int<unsigned>(n_iterations);
  }
 
  NonlinearImplicitSystem & sys = solver->system();
 
  PetscVector<Number> & X_sys = *cast_ptr<PetscVector<Number> *>(sys.solution.get());
 
  PetscVector<Number> X_global(x, sys.comm());
 
  // Use the system's update() to get a good local version of the
  // parallel solution.  This operation does not modify the incoming
  // "x" vector, it only localizes information from "x" into
  // sys.current_local_solution.
  X_global.swap(X_sys);
  sys.update();
  X_global.swap(X_sys);
 
  // Enforce constraints (if any) exactly on the
  // current_local_solution.  This is the solution vector that is
  // actually used in the computation of the residual below, and is
  // not locked by debug-enabled PETSc the way that "x" is.
  if (solver->_exact_constraint_enforcement)
    sys.get_dof_map().enforce_constraints_exactly(sys, sys.current_local_solution.get());
 
  return ResidualContext(solver, sys);
}

Member Data Documentation

◆ _communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 120 of file parallel_object.h.

Referenced by libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::StaticCondensation::close(), libMesh::ParallelObject::comm(), libMesh::CondensedEigenSystem::initialize_condensed_matrices(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), libMesh::ParallelObject::processor_id(), libMesh::BoundaryInfo::regenerate_id_sets(), libMesh::StaticCondensationDofMap::reinit(), and libMesh::BoundaryInfo::synchronize_global_id_set().

◆ _computing_base_vector

template<typename T >

bool libMesh::PetscNonlinearSolver< T >::_computing_base_vector

protected

Whether we are computing the base vector for matrix-free finite differencing.

Definition at line 311 of file petsc_nonlinear_solver.h.

Referenced by libMesh::PetscNonlinearSolver< T >::computing_base_vector(), and libMesh::PetscNonlinearSolver< T >::set_computing_base_vector().

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info().

◆ _current_nonlinear_iteration_number

template<typename T >

unsigned libMesh::PetscNonlinearSolver< T >::_current_nonlinear_iteration_number

protected

Stores the current nonlinear iteration number.

Definition at line 275 of file petsc_nonlinear_solver.h.

Referenced by libMesh::PetscNonlinearSolver< T >::get_current_nonlinear_iteration_number().

◆ _default_monitor

template<typename T >

bool libMesh::PetscNonlinearSolver< T >::_default_monitor

protected

true if we want the default monitor to be set, false for no monitor (i.e.

user code can use their own)

Definition at line 290 of file petsc_nonlinear_solver.h.

Referenced by libMesh::PetscNonlinearSolver< T >::use_default_monitor().

◆ _dm_wrapper

template<typename T >

PetscDMWrapper libMesh::PetscNonlinearSolver< T >::_dm_wrapper

protected

Wrapper object for interacting with the "new" libMesh PETSc DM.

The new libMesh PETSc DM implementation is capable of geometric multigrid while the old implementation is not. The new implementation can be activated from the command line with –use_petsc_dm

Definition at line 324 of file petsc_nonlinear_solver.h.

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 143 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

◆ _exact_constraint_enforcement

template<typename T >

bool libMesh::NonlinearSolver< T >::_exact_constraint_enforcement

protectedinherited

Whether we should enforce exact constraints globally during a solve.

Definition at line 433 of file nonlinear_solver.h.

Referenced by libMesh::Problem_Interface::computeJacobian(), libMesh::NonlinearSolver< T >::exact_constraint_enforcement(), and libMesh::NonlinearSolver< T >::set_exact_constraint_enforcement().

◆ _is_initialized

template<typename T >

bool libMesh::NonlinearSolver< T >::_is_initialized

protectedinherited

Flag indicating if the data structures have been initialized.

Definition at line 448 of file nonlinear_solver.h.

Referenced by libMesh::NonlinearSolver< T >::initialized().

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 of file reference_counter.h.

◆ _n_linear_iterations

template<typename T >

PetscInt libMesh::PetscNonlinearSolver< T >::_n_linear_iterations

protected

Stores the total number of linear iterations from the last solve.

Definition at line 270 of file petsc_nonlinear_solver.h.

◆ _n_objects

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 132 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _preconditioner

template<typename T >

Preconditioner<T>* libMesh::NonlinearSolver< T >::_preconditioner

protectedinherited

Holds the Preconditioner object to be used for the linear solves.

Definition at line 453 of file nonlinear_solver.h.

◆ _reason

template<typename T >

SNESConvergedReason libMesh::PetscNonlinearSolver< T >::_reason

protected

Store the reason for SNES convergence/divergence for use even after the _snes has been cleared.

Note: print_converged_reason() will always try to get the current reason with SNESGetConvergedReason(), but if the SNES object has already been cleared, it will fall back on this stored value. This value is therefore necessarily not cleared by the clear() function.

Definition at line 265 of file petsc_nonlinear_solver.h.

◆ _reproducible_residual

template<typename T >

bool libMesh::PetscNonlinearSolver< T >::_reproducible_residual

Referenced by libMesh::PetscNonlinearSolver< T >::set_snesmf_reuse_base(), and libMesh::PetscNonlinearSolver< T >::snes_mf_reuse_base().

template<typename T >

double libMesh::NonlinearSolver< T >::absolute_step_tolerance

inherited

The NonlinearSolver should exit after the full nonlinear step norm is reduced to either less than absolute_step_tolerance or less than relative_step_tolerance times the largest nonlinear solution which has been seen so far.

Users should increase any of these tolerances that they want to use for a stopping condition.

Note: Not all NonlinearSolvers support relative_step_tolerance!

Definition at line 343 of file nonlinear_solver.h.

◆ bounds

template<typename T >

void(* libMesh::NonlinearSolver< T >::bounds) (NumericVector< Number > &XL, NumericVector< Number > &XU, sys_type &S)

inherited

Function that computes the lower and upper bounds XL and XU on the solution of the nonlinear system.

Definition at line 205 of file nonlinear_solver.h.

◆ bounds_object

template<typename T >

NonlinearImplicitSystem::ComputeBounds* libMesh::NonlinearSolver< T >::bounds_object

inherited

Object that computes the bounds vectors \( XL \) and \( XU \).

Definition at line 211 of file nonlinear_solver.h.

◆ converged

template<typename T >

bool libMesh::NonlinearSolver< T >::converged

inherited

After a call to solve this will reflect whether or not the nonlinear solve was successful.

Definition at line 367 of file nonlinear_solver.h.

◆ divergence_tolerance

template<typename T >

double libMesh::NonlinearSolver< T >::divergence_tolerance

inherited

The NonlinearSolver should exit if the residual becomes greater than the initial residual times the divergence_tolerance.

Users should adjust this tolerances to prevent divergence of the NonlinearSolver.

Definition at line 330 of file nonlinear_solver.h.

◆ fd_residual_object

template<typename T >

NonlinearImplicitSystem::ComputeResidual* libMesh::NonlinearSolver< T >::fd_residual_object

inherited

Object that computes the residual R(X) of the nonlinear system at the input iterate X for the purpose of forming a finite-differenced Jacobian.

Definition at line 158 of file nonlinear_solver.h.

template<typename T >

std::unique_ptr<ComputeLineSearchObject> libMesh::PetscNonlinearSolver< T >::linesearch_object

A callable object that can be used to specify a custom line-search.

Definition at line 226 of file petsc_nonlinear_solver.h.

Referenced by libMesh::libmesh_petsc_linesearch_shellfunc().

◆ matvec

template<typename T >

void(* libMesh::NonlinearSolver< T >::matvec) (const NumericVector< Number > &X, NumericVector< Number > *R, SparseMatrix< Number > *J, sys_type &S)

inherited

Function that computes either the residual \( R(X) \) or the Jacobian \( J(X) \) of the nonlinear system at the input iterate \( X \).

Note: Either R or J could be nullptr.

Function that performs a "check" on the Newton search direction and solution after each nonlinear step.

See documentation for the NonlinearImplicitSystem::ComputePostCheck object for more information about the calling sequence.

Definition at line 269 of file nonlinear_solver.h.

Referenced by libMesh::libmesh_petsc_snes_postcheck().

◆ postcheck_object

template<typename T >

NonlinearImplicitSystem::ComputePostCheck* libMesh::NonlinearSolver< T >::postcheck_object

inherited

A callable object that is executed after each nonlinear iteration.

Allows the user to modify both the search direction and the solution vector in an application-specific way.

Definition at line 281 of file nonlinear_solver.h.

Referenced by libMesh::libmesh_petsc_snes_postcheck().

◆ precheck_object

template<typename T >

NonlinearImplicitSystem::ComputePreCheck* libMesh::NonlinearSolver< T >::precheck_object

inherited

Definition at line 283 of file nonlinear_solver.h.

◆ relative_residual_tolerance

template<typename T >

double libMesh::NonlinearSolver< T >::relative_residual_tolerance

inherited

Definition at line 321 of file nonlinear_solver.h.

◆ relative_step_tolerance

template<typename T >

double libMesh::NonlinearSolver< T >::relative_step_tolerance

inherited

Definition at line 344 of file nonlinear_solver.h.

◆ residual

template<typename T >

void(* libMesh::NonlinearSolver< T >::residual) (const NumericVector< Number > &X, NumericVector< Number > &R, sys_type &S)

inherited

Function that computes the residual R(X) of the nonlinear system at the input iterate X.

Definition at line 144 of file nonlinear_solver.h.

◆ residual_and_jacobian_object

template<typename T >

NonlinearImplicitSystem::ComputeResidualandJacobian* libMesh::NonlinearSolver< T >::residual_and_jacobian_object

inherited

Object that computes either the residual \( R(X) \) or the Jacobian \( J(X) \) of the nonlinear system at the input iterate \( X \).

Note: Either R or J could be nullptr.

Definition at line 200 of file nonlinear_solver.h.

Referenced by libMesh::Problem_Interface::computeJacobian(), and libMesh::Problem_Interface::computePreconditioner().

◆ residual_object

template<typename T >

NonlinearImplicitSystem::ComputeResidual* libMesh::NonlinearSolver< T >::residual_object

inherited

Object that computes the residual R(X) of the nonlinear system at the input iterate X.

Definition at line 152 of file nonlinear_solver.h.

◆ transpose_nullspace

template<typename T >

void(* libMesh::NonlinearSolver< T >::transpose_nullspace) (std::vector< NumericVector< Number > * > &sp, sys_type &S)

inherited

Function that computes a basis for the transpose Jacobian's nullspace – when solving a degenerate problem iteratively, if the solver supports it (e.g., PETSc's KSP), it is used to remove contributions outside of R(jac)

Definition at line 234 of file nonlinear_solver.h.

◆ transpose_nullspace_object

template<typename T >

NonlinearImplicitSystem::ComputeVectorSubspace* libMesh::NonlinearSolver< T >::transpose_nullspace_object

inherited

A callable object that computes a basis for the transpose Jacobian's nullspace – when solving a degenerate problem iteratively, if the solver supports it (e.g., PETSc's KSP), it is used to remove contributions outside of R(jac)

Definition at line 241 of file nonlinear_solver.h.

◆ user_presolve

template<typename T >

void(* libMesh::NonlinearSolver< T >::user_presolve) (sys_type &S)

inherited

Customizable function pointer which users can attach to the solver.

Gets called prior to every call to solve().

Definition at line 261 of file nonlinear_solver.h.

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

include/solvers/petsc_nonlinear_solver.h
src/solvers/petsc_nonlinear_solver.C

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Counts

◆ sys_type

Constructor & Destructor Documentation

◆ PetscNonlinearSolver()

◆ ~PetscNonlinearSolver()

Member Function Documentation

◆ attach_preconditioner()

◆ build()

◆ build_mat_null_space()

◆ clear()

◆ comm()

◆ computing_base_vector()

◆ disable_print_counter_info()

◆ enable_print_counter_info()

◆ exact_constraint_enforcement()

◆ force_new_preconditioner()

◆ get_converged_reason()

◆ get_current_nonlinear_iteration_number()

◆ get_info()

◆ get_total_linear_iterations()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ init()

◆ initialized()

◆ n_objects()

◆ n_processors()

◆ print_converged_reason()

◆ print_info()

◆ processor_id()

◆ reproducible_residual()

◆ reuse_preconditioner()

◆ reuse_preconditioner_max_linear_its()

◆ set_computing_base_vector()

◆ set_exact_constraint_enforcement()

◆ set_jacobian_zero_out()

◆ set_reproducible_residual()

◆ set_residual_zero_out()

◆ set_reuse_preconditioner()

◆ set_reuse_preconditioner_max_linear_its()

◆ set_snesmf_reuse_base()

◆ set_solver_configuration()

◆ setup_default_monitor()

◆ snes()

◆ snes_mf_reuse_base()

◆ solve() [1/2]

◆ solve() [2/2]

◆ system() [1/2]

◆ system() [2/2]

◆ use_default_monitor()

Friends And Related Symbol Documentation

◆ libmesh_petsc_snes_fd_residual

◆ libmesh_petsc_snes_jacobian

◆ libmesh_petsc_snes_mffd_residual

◆ libmesh_petsc_snes_precheck

◆ libmesh_petsc_snes_residual

◆ libmesh_petsc_snes_residual_helper

Member Data Documentation

◆ _communicator

◆ _computing_base_vector

◆ _counts

◆ _current_nonlinear_iteration_number

◆ _default_monitor

◆ _dm_wrapper

◆ _enable_print_counter

◆ _exact_constraint_enforcement

◆ _is_initialized

◆ _mutex

◆ _n_linear_iterations