lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType > Class Template Reference

#include <nl_keigen_ags_solver.h>

Inheritance diagram for lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >:

Public Types
typedef NLKEigenAGSContext< VecType, SolverType >	NLKAGSContext
typedef std::shared_ptr< NLKAGSContext >	NLKAGSContextPtr
Public Types inherited from chi_math::NonLinearSolver< MatType, VecType, SolverType >
typedef NonLinearSolverContext< VecType, SolverType >	NLSolverContext
typedef std::shared_ptr< NLSolverContext >	NLSolverContextPtr

Public Member Functions
	NLKEigenvalueAGSSolver (NLKAGSContextPtr nlk_ags_context_ptr)
virtual	~NLKEigenvalueAGSSolver () override=default
Public Member Functions inherited from chi_math::NonLinearSolver< MatType, VecType, SolverType >
	NonLinearSolver (NLSolverContextPtr context_ptr, const chi::InputParameters &params=NonLinearSolverOptions::GetInputParameters())
virtual	~NonLinearSolver ()
NonLinearSolverOptions &	ToleranceOptions ()
void	ApplyToleranceOptions ()
NLSolverContextPtr &	GetContext ()
bool	IsConverged () const
std::string	GetConvergedReasonString () const
virtual void	Setup ()
virtual void	Solve ()

Protected Member Functions
void	PreSetupCallback () override
void	SetMonitor () override
void	SetSystemSize () override
void	SetSystem () override
void	SetFunction () override
void	SetJacobian () override
void	SetInitialGuess () override
void	PostSolveCallback () override
void	PreSetupCallback ()
void	SetMonitor ()
void	SetSystemSize ()
void	SetSystem ()
void	SetFunction ()
void	SetJacobian ()
void	SetInitialGuess ()
void	PostSolveCallback ()
Protected Member Functions inherited from chi_math::NonLinearSolver< MatType, VecType, SolverType >
bool	IsSystemSet () const
virtual void	PreSetupCallback ()
virtual void	SetOptions ()
virtual void	SetSolverContext ()
virtual void	SetConvergenceTest ()
virtual void	SetMonitor ()
virtual void	SetPreconditioner ()
virtual void	SetSystemSize ()=0
virtual void	SetSystem ()=0
virtual void	SetFunction ()=0
virtual void	SetJacobian ()=0
virtual void	PostSetupCallback ()
virtual void	PreSolveCallback ()
virtual void	SetInitialGuess ()=0
virtual void	PostSolveCallback ()

Additional Inherited Members
Protected Attributes inherited from chi_math::NonLinearSolver< MatType, VecType, SolverType >
const std::string	solver_name_
NLSolverContextPtr	context_ptr_ = nullptr
MatType	J_
MatType	P_
VecType	r_
VecType	x_
SolverType	nl_solver_
int64_t	num_local_dofs_ = 0
int64_t	num_globl_dofs_ = 0
NonLinearSolverOptions	options_

Detailed Description

template<class MatType, class VecType, class SolverType>
class lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >

Definition at line 11 of file nl_keigen_ags_solver.h.

Member Typedef Documentation

NLKAGSContext

template<class MatType , class VecType , class SolverType >

typedef NLKEigenAGSContext<VecType, SolverType> lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::NLKAGSContext

Definition at line 15 of file nl_keigen_ags_solver.h.

NLKAGSContextPtr

template<class MatType , class VecType , class SolverType >

typedef std::shared_ptr<NLKAGSContext> lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::NLKAGSContextPtr

Definition at line 16 of file nl_keigen_ags_solver.h.

Constructor & Destructor Documentation

NLKEigenvalueAGSSolver()

template<class MatType , class VecType , class SolverType >

lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::NLKEigenvalueAGSSolver ( NLKAGSContextPtr  nlk_ags_context_ptr )

inlineexplicit

Definition at line 18 of file nl_keigen_ags_solver.h.

~NLKEigenvalueAGSSolver()

template<class MatType , class VecType , class SolverType >

virtual lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::~NLKEigenvalueAGSSolver ( )

overridevirtualdefault

Member Function Documentation

PostSolveCallback() [1/2]

void lbs::NLKEigenvalueAGSSolver< SNESTypes >::PostSolveCallback ( )

protectedvirtual

Reimplemented from chi_math::NonLinearSolver< MatType, VecType, SolverType >.

Definition at line 107 of file nl_keigen_ags_solver.cc.

PostSolveCallback() [2/2]

template<class MatType , class VecType , class SolverType >

void lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::PostSolveCallback ( )

overrideprotectedvirtual

Reimplemented from chi_math::NonLinearSolver< MatType, VecType, SolverType >.

PreSetupCallback() [1/2]

void lbs::NLKEigenvalueAGSSolver< SNESTypes >::PreSetupCallback ( )

protectedvirtual

Reimplemented from chi_math::NonLinearSolver< MatType, VecType, SolverType >.

Definition at line 29 of file nl_keigen_ags_solver.cc.

PreSetupCallback() [2/2]

template<class MatType , class VecType , class SolverType >

void lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::PreSetupCallback ( )

overrideprotectedvirtual

Reimplemented from chi_math::NonLinearSolver< MatType, VecType, SolverType >.

SetFunction() [1/2]

void lbs::NLKEigenvalueAGSSolver< SNESTypes >::SetFunction ( )

protectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

Definition at line 79 of file nl_keigen_ags_solver.cc.

SetFunction() [2/2]

template<class MatType , class VecType , class SolverType >

void lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::SetFunction ( )

overrideprotectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

SetInitialGuess() [1/2]

void lbs::NLKEigenvalueAGSSolver< SNESTypes >::SetInitialGuess ( )

protectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

Definition at line 95 of file nl_keigen_ags_solver.cc.

SetInitialGuess() [2/2]

template<class MatType , class VecType , class SolverType >

void lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::SetInitialGuess ( )

overrideprotectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

SetJacobian() [1/2]

void lbs::NLKEigenvalueAGSSolver< SNESTypes >::SetJacobian ( )

protectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

Definition at line 88 of file nl_keigen_ags_solver.cc.

SetJacobian() [2/2]

template<class MatType , class VecType , class SolverType >

void lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::SetJacobian ( )

overrideprotectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

SetMonitor() [1/2]

void lbs::NLKEigenvalueAGSSolver< SNESTypes >::SetMonitor ( )

protectedvirtual

Reimplemented from chi_math::NonLinearSolver< MatType, VecType, SolverType >.

Definition at line 39 of file nl_keigen_ags_solver.cc.

SetMonitor() [2/2]

template<class MatType , class VecType , class SolverType >

void lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::SetMonitor ( )

overrideprotectedvirtual

Reimplemented from chi_math::NonLinearSolver< MatType, VecType, SolverType >.

SetSystem() [1/2]

void lbs::NLKEigenvalueAGSSolver< SNESTypes >::SetSystem ( )

protectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

Definition at line 70 of file nl_keigen_ags_solver.cc.

SetSystem() [2/2]

template<class MatType , class VecType , class SolverType >

void lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::SetSystem ( )

overrideprotectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

SetSystemSize() [1/2]

void lbs::NLKEigenvalueAGSSolver< SNESTypes >::SetSystemSize ( )

protectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

Definition at line 58 of file nl_keigen_ags_solver.cc.

SetSystemSize() [2/2]

template<class MatType , class VecType , class SolverType >

void lbs::NLKEigenvalueAGSSolver< MatType, VecType, SolverType >::SetSystemSize ( )

overrideprotectedvirtual

Implements chi_math::NonLinearSolver< MatType, VecType, SolverType >.

---

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

• modules/LinearBoltzmannSolvers/A_LBSSolver/IterativeMethods/nl_keigen_ags_solver.h