oft_native_cg_eigsolver Type Reference

Detailed Description

CG eigensolver class.

Note

Matrix system must be SPD, otherwise solver will fail.

Inheritance diagram for oft_native_cg_eigsolver:

Public Member Functions
procedure	apply (self, u, alam)
	Solve system.
procedure(eigsolver_apply), deferred	apply (self, u, alam)
	Solve Eigen-system.
procedure	delete (self)
	Clean-up internal storage.
procedure(eigsolver_delete), deferred	delete (self)
	Clean-up internal storage.

Public Attributes
class(oft_matrix), pointer	a => NULL()
	LHS matrix.
real(r8)	atol = 1.d-14
	Absolute convergence tolerance \( |res| < atol \).
class(oft_solver_bc), pointer	bc => NULL()
	Boundary condition.
integer(i4)	cits = 0
	Number of iteractions to convergence.
logical	initialized = .FALSE.
	Solver has been constructed.
integer(i4)	itplot =10
	Output frequency for iterative solvers when pm=.TRUE.
integer(i4)	its = -1
	Maximum iteration count.
class(oft_matrix), pointer	m => NULL()
	RHS matrix.
integer(i4)	ninner = -1
integer(i4)	nrestarts = 2
class(oft_solver_bc), pointer	orthog => NULL()
	Orthogonalization.
logical	pm = .FALSE.
	Performance monitor override.
class(oft_solver), pointer	pre => NULL()
	Preconditioner.
real(r8)	rtol = 1.d-14
	Relative convergence tolerance \( |res|/|res_0| < rtol \).

Member Function/Subroutine Documentation

apply() [1/2]

procedure apply	(	class(oft_native_cg_eigsolver), intent(inout)	self,
		class(oft_vector), intent(inout)	u,
		real(r8), intent(inout)	alam
	)

Solve system.

This solver uses a Non-Linear Conjugate-Gradient method to minimize the Rayleigh Quotient ( \( R = \frac{x*A*x}{x*M*x} \)).

Parameters

[in,out]	self	Solver object
[in,out]	u	Guess (input), Solution (output)
[in,out]	alam	Eigenvalue

apply() [2/2]

procedure(eigsolver_apply), deferred apply ( class(oft_eigsolver), intent(inout)  self, class(oft_vector), intent(inout)  u, real(r8), intent(inout)  alam  )

pure virtualinherited

Solve Eigen-system.

Parameters

[in,out]	self	Solver object
[in,out]	u	Guess/Solution field
[in,out]	alam	Eigenvalue

delete() [1/2]

procedure delete

(

class(oft_native_cg_eigsolver), intent(inout)

self

)

Clean-up internal storage.

Parameters

[in,out]

self

Solver object

delete() [2/2]

procedure(eigsolver_delete), deferred delete ( class(oft_eigsolver), intent(inout)  self )

pure virtualinherited

Clean-up internal storage.

Parameters

[in,out]

self

Solver object

Member Data Documentation

a

class(oft_matrix), pointer a => NULL()

inherited

LHS matrix.

atol

real(r8) atol = 1.d-14

inherited

Absolute convergence tolerance \( |res| < atol \).

bc

class(oft_solver_bc), pointer bc => NULL()

Boundary condition.

cits

integer(i4) cits = 0

inherited

Number of iteractions to convergence.

initialized

logical initialized = .FALSE.

inherited

Solver has been constructed.

itplot

integer(i4) itplot =10

inherited

Output frequency for iterative solvers when pm=.TRUE.

its

integer(i4) its = -1

inherited

Maximum iteration count.

m

class(oft_matrix), pointer m => NULL()

inherited

RHS matrix.

ninner

integer(i4) ninner = -1

nrestarts

integer(i4) nrestarts = 2

orthog

class(oft_solver_bc), pointer orthog => NULL()

Orthogonalization.

pm

logical pm = .FALSE.

inherited

Performance monitor override.

pre

class(oft_solver), pointer pre => NULL()

inherited

Preconditioner.

rtol

real(r8) rtol = 1.d-14

inherited

Relative convergence tolerance \( |res|/|res_0| < rtol \).

---

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

• /home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/lin_alg/native_solvers.F90