The Open FUSION Toolkit 1.0.0-8905cc5
Modeling tools for plasma and fusion research and engineering
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
oft_eigsolver Type Referenceabstract

Detailed Description

Base class for OFT eigenvalue solvers.

Inheritance diagram for oft_eigsolver:
Inheritance graph
[legend]

Public Member Functions

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

Public Attributes

class(oft_matrix), pointer a => NULL()
 LHS matrix.
 
real(r8atol = 1.d-14
 Absolute convergence tolerance \( |res| < atol \).
 
integer(i4cits = 0
 Number of iteractions to convergence.
 
logical initialized = .FALSE.
 Solver has been constructed.
 
integer(i4itplot =10
 Output frequency for iterative solvers when pm=.TRUE.
 
integer(i4its = -1
 Maximum iteration count.
 
class(oft_matrix), pointer m => NULL()
 RHS matrix.
 
logical pm = .FALSE.
 Performance monitor override.
 
class(oft_solver), pointer pre => NULL()
 Preconditioner.
 
real(r8rtol = 1.d-14
 Relative convergence tolerance \( |res|/|res_0| < rtol \).
 

Member Function/Subroutine Documentation

◆ apply()

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

Solve Eigen-system.

Parameters
[in,out]selfSolver object
[in,out]uGuess/Solution field
[in,out]alamEigenvalue

◆ delete()

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

Clean-up internal storage.

Parameters
[in,out]selfSolver object

Member Data Documentation

◆ a

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

LHS matrix.

◆ atol

real(r8) atol = 1.d-14

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

◆ cits

integer(i4) cits = 0

Number of iteractions to convergence.

◆ initialized

logical initialized = .FALSE.

Solver has been constructed.

◆ itplot

integer(i4) itplot =10

Output frequency for iterative solvers when pm=.TRUE.

◆ its

integer(i4) its = -1

Maximum iteration count.

◆ m

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

RHS matrix.

◆ pm

logical pm = .FALSE.

Performance monitor override.

◆ pre

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

Preconditioner.

◆ rtol

real(r8) rtol = 1.d-14

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


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