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

Detailed Description

Multi-level preconditioner level.

Note
This class acts as a driver/container for separate solver objects as a result any linear algebra backend may be used with this type.
Inheritance diagram for oft_ml_precond:
Inheritance graph
[legend]

Public Member Functions

procedure apply (self, u, g)
 Apply smoother.
 
procedure(solver_apply), deferred apply (self, u, g)
 Solve system.
 
procedure check_thread (self)
 Check thread safety.
 
procedure delete (self)
 Clean-up internal smoother storage.
 
procedure(solver_delete), deferred delete (self)
 Clean-up internal storage.
 
procedure setup_from_xml (self, solver_node, level)
 Setup solver from XML node.
 
procedure update (self, new_pattern)
 Update children with new settings/operators.
 
procedure update (self, new_pattern)
 Update solver with new settings/operators.
 
procedure view (self)
 Print solver information.
 
procedure view (self)
 Print solver information.
 

Public Attributes

class(oft_matrix), pointer a => NULL()
 Matrix to be inverted.
 
real(r8) atol = 1.d-14
 Absolute convergence tolerance \( |res| < atol \).
 
class(oft_solver), pointer base_solve => NULL()
 Pointer to lower level solve.
 
class(oft_solver_bc), pointer bc => NULL()
 Boundary condition.
 
integer(i4) cits = 0
 Number of iteractions to convergence.
 
logical full_residual = .TRUE.
 Output true residual on exit.
 
class(oft_vector), pointer gcors => NULL()
 Temporary coarse vector.
 
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.
 
integer(i4) level
 Current level in ML context.
 
integer(i4) minlevel
 Lowest level.
 
class(oft_ml_vecspace), pointer ml_vecspace => NULL()
 Multi-level vector space.
 
class(oft_vector), pointer p => NULL()
 Temporary vector.
 
logical pm = .FALSE.
 Performance monitor override.
 
class(oft_solver), pointer pre => NULL()
 Preconditioner.
 
class(oft_vector), pointer r => NULL()
 Temporary vector.
 
real(r8) rtol = 1.d-14
 Relative convergence tolerance \( |res|/|res_0| < rtol \).
 
class(oft_solver), pointer smooth_down => NULL()
 Smoother for down-cycle.
 
class(oft_solver), pointer smooth_up => NULL()
 Smoother for up-cycle.
 
logical symmetric = .FALSE.
 Symmetric flag.
 
real(r8), dimension(4) timings = 0.d0
 Timing for each stage.
 
class(oft_vector), pointer ucors => NULL()
 Temporary coarse vector.
 

Member Function/Subroutine Documentation

◆ apply() [1/2]

procedure apply ( class(oft_ml_precond), intent(inout)  self,
class(oft_vector), intent(inout)  u,
class(oft_vector), intent(inout)  g 
)

Apply smoother.

Parameters
[in,out]selfSolver object
[in,out]uGuess (input), Solution (output)
[in,out]gRHS (input), Residual (output)

◆ apply() [2/2]

procedure(solver_apply), deferred apply ( class(oft_solver), intent(inout)  self,
class(oft_vector), intent(inout)  u,
class(oft_vector), intent(inout)  g 
)
pure virtualinherited

Solve system.

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

◆ check_thread()

procedure check_thread ( class(oft_solver), intent(inout)  self)
inherited

Check thread safety.

Parameters
[in,out]selfSolver object

◆ delete() [1/2]

procedure delete ( class(oft_ml_precond), intent(inout)  self)

Clean-up internal smoother storage.

Parameters
[in,out]selfSolver object

◆ delete() [2/2]

procedure(solver_delete), deferred delete ( class(oft_solver), intent(inout)  self)
pure virtualinherited

Clean-up internal storage.

Parameters
[in,out]selfSolver object

◆ setup_from_xml()

procedure setup_from_xml ( class(oft_solver), intent(inout)  self,
type(xml_node), intent(in), pointer  solver_node,
integer(i4), intent(in), optional  level 
)
inherited

Setup solver from XML node.

Note
This subroutine is a dummy routine used to specify the interface of the member function and catch errors in uninitialized solvers
Parameters
[in,out]selfSolver object
[in]solver_nodeXML element containing solver definition
[in]levelLevel in MG hierarchy (optional)

◆ update() [1/2]

procedure update ( class(oft_ml_precond), intent(inout)  self,
logical, intent(in), optional  new_pattern 
)

Update children with new settings/operators.

Parameters
[in,out]selfSolver object

◆ update() [2/2]

procedure update ( class(oft_solver), intent(inout)  self,
logical, intent(in), optional  new_pattern 
)
inherited

Update solver with new settings/operators.

Note
This subroutine is a dummy routine used to specify the interface of the member function and catch errors in uninitialized solvers
Parameters
[in,out]selfSolver object
[in]new_patternUpdate matrix non-zero pattern? (optional)

◆ view() [1/2]

procedure view ( class(oft_ml_precond), intent(inout)  self)

Print solver information.

Parameters
[in,out]selfSolver object

◆ view() [2/2]

procedure view ( class(oft_solver), intent(inout)  self)
inherited

Print solver information.

Note
This subroutine is a dummy routine used to specify the interface of the member function and catch errors in uninitialized solvers
Parameters
[in,out]selfSolver object

Member Data Documentation

◆ a

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

Matrix to be inverted.

◆ atol

real(r8) atol = 1.d-14
inherited

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

◆ base_solve

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

Pointer to lower level solve.

◆ bc

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

Boundary condition.

◆ cits

integer(i4) cits = 0
inherited

Number of iteractions to convergence.

◆ full_residual

logical full_residual = .TRUE.
inherited

Output true residual on exit.

◆ gcors

class(oft_vector), pointer gcors => NULL()

Temporary coarse vector.

◆ 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.

◆ level

integer(i4) level

Current level in ML context.

◆ minlevel

integer(i4) minlevel

Lowest level.

◆ ml_vecspace

class(oft_ml_vecspace), pointer ml_vecspace => NULL()

Multi-level vector space.

◆ p

class(oft_vector), pointer p => NULL()

Temporary vector.

◆ pm

logical pm = .FALSE.
inherited

Performance monitor override.

◆ pre

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

Preconditioner.

◆ r

class(oft_vector), pointer r => NULL()

Temporary vector.

◆ rtol

real(r8) rtol = 1.d-14
inherited

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

◆ smooth_down

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

Smoother for down-cycle.

◆ smooth_up

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

Smoother for up-cycle.

◆ symmetric

logical symmetric = .FALSE.

Symmetric flag.

◆ timings

real(r8), dimension(4) timings = 0.d0

Timing for each stage.

◆ ucors

class(oft_vector), pointer ucors => NULL()

Temporary coarse vector.

The documentation for this type was generated from the following file:
Generated by doxygen 1.9.8