scalar_pde – Morfeus Framework

type, public, extends(pde) :: scalar_pde

Inherits

Components

Type	Visibility	Attributes		Name		Initial
real(kind=psb_dpk_),	private,	allocatable	::	b(:)

Type-Bound Procedures

procedure, public :: asb_pde_

interface

Getters
Read more…
private module subroutine asb_pde_(eqn)

Arguments

Type Intent Optional Attributes Name

class(scalar_pde), intent(inout) :: eqn

Type	Intent	Optional	Attributes		Name
class(scalar_pde),	intent(inout)			::	eqn

procedure, public :: build_pde_prec

interface

Constructor
Read more…
private module subroutine build_pde_prec(eqn)

Arguments

Type Intent Optional Attributes Name

class(pde), intent(inout) :: eqn

procedure, public :: create_pde

Constructor

interface

Getters

private module subroutine create_pde(eqn, input_file, sec, msh, dim)

----- Constructor -----

Arguments

Type	Intent	Attributes		Name
class(scalar_pde),	intent(out)		::	eqn
character(len=*),	intent(in)		::	input_file
character(len=*),	intent(in)		::	sec
type(mesh),	intent(inout),	target	::	msh
type(dimensions),	intent(in)		::	dim

generic, public :: dim_ => get_pde_dim

private interface get_pde_dim()

Constructor
Read more…
Arguments
None

procedure, public :: free_pde

Destructor

interface

Getters
Read more…
private module subroutine free_pde(eqn)

----- Destructor -----

Arguments

Type Intent Optional Attributes Name

class(scalar_pde), intent(inout) :: eqn

Type	Intent	Optional	Attributes		Name
class(scalar_pde),	intent(inout)			::	eqn

procedure, public :: free_pde_prec

interface

Constructor
Read more…
private module subroutine free_pde_prec(eqn)

Arguments

Type Intent Optional Attributes Name

class(pde), intent(inout) :: eqn

generic, public :: geins_pde => geins_scalar_pde

Linear System Solving

private interface geins_scalar_pde()

Getters
Read more…
Arguments
None

procedure, public, pass(pde) :: geins_scalar_pde

interface

Getters

private module subroutine geins_scalar_pde(n, ia, cloud, pde)

Inserts a ``cloud'' of RHS terms into pde%b

Arguments

Type	Intent		Name
integer,	intent(in)	::	n
integer,	intent(in)	::	ia(:)
real(kind=psb_dpk_),	intent(in)	::	cloud(:)
class(scalar_pde),	intent(inout)	::	pde

generic, public :: get_a => get_pde_a

private interface get_pde_a()

Constructor
Read more…
Arguments
None

generic, public :: get_diag => get_pde_diag

private interface get_pde_diag()

Constructor
Read more…
Arguments
None

generic, public :: get_mesh => get_pde_msh_sub

private interface get_pde_msh_sub()

Constructor
Read more…
Arguments
None

procedure, public :: is_pde_asb

Status inquirer

interface

Constructor
Read more…
private module function is_pde_asb(eqn)

Arguments

Type Intent Optional Attributes Name

class(pde), intent(in) :: eqn

Return Value logical

procedure, public :: is_pde_bld

interface

Constructor
Read more…
private module function is_pde_bld(eqn)

Arguments

Type Intent Optional Attributes Name

class(pde), intent(in) :: eqn

Return Value logical

generic, public :: msh_ => get_pde_msh_fun

private interface get_pde_msh_fun()

Constructor
Read more…
Arguments
None

generic, public :: name_ => get_pde_name

private interface get_pde_name()

Constructor
Read more…
Arguments
None

procedure, public :: nemo_sizeof

interface

Getters
Read more…
private module function nemo_sizeof(eqn)

Arguments

Type Intent Optional Attributes Name

class(scalar_pde), intent(in) :: eqn

Return Value integer(kind=nemo_int_long_)

procedure, public :: reinit_pde

interface

Getters
Read more…
private module subroutine reinit_pde(eqn)

Arguments

Type Intent Optional Attributes Name

class(scalar_pde), intent(inout) :: eqn

Type	Intent	Optional	Attributes		Name
class(scalar_pde),	intent(inout)			::	eqn

generic, public :: solve_pde => solve_scalar_pde

private interface solve_scalar_pde()

Getters
Read more…
Arguments
None

procedure, public :: solve_pde_sys

interface

Constructor

private module subroutine solve_pde_sys(eqn, b, x, iter, err)

Arguments

Type	Intent		Name
class(pde),	intent(inout)	::	eqn
real(kind=psb_dpk_),	intent(in)	::	b(:)
real(kind=psb_dpk_),	intent(out)	::	x(:)
integer,	intent(out)	::	iter
real(kind=psb_dpk_),	intent(out)	::	err

procedure, public, pass(eqn) :: spins_pde

Linear System Solving

interface

Constructor

private module subroutine spins_pde(n, ia, ja, cloud, eqn)

Linear System Solving Inserts a ``cloud'' of coefficients into eqn%A

Arguments

Type	Intent		Name
integer,	intent(in)	::	n
integer,	intent(in)	::	ia(:)
integer,	intent(in)	::	ja(:)
real(kind=psb_dpk_),	intent(in)	::	cloud(:)
class(pde),	intent(inout)	::	eqn

generic, public :: update_diag => update_pde_diag

private interface update_pde_diag()

Constructor
Read more…
Arguments
None

procedure, public :: write_pde

interface

Constructor

private module subroutine write_pde(eqn, mat, mtx_rhs)

Output

Arguments

Type	Intent		Name
class(pde),	intent(in)	::	eqn
character(len=*),	intent(in)	::	mat
logical,	intent(out)	::	mtx_rhs

procedure, public :: write_scalar_pde

interface

Getters

private module subroutine write_scalar_pde(eqn, mat, rhs)

----- Output -----

Arguments

Type	Intent		Name
class(scalar_pde),	intent(in)	::	eqn
character(len=*),	intent(in)	::	mat
character(len=*),	intent(in)	::	rhs

procedure, private :: solve_scalar_pde

interface

Getters

private module subroutine solve_scalar_pde(pde, mats, phi, var)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_pde),	intent(inout)			::	pde
type(matptr),	intent(in),	optional	pointer	::	mats(:)
type(scalar_field),	intent(inout)			::	phi
real(kind=psb_dpk_),	intent(out),	optional		::	var

Source Code

    TYPE, EXTENDS(PDE) :: scalar_pde
        PRIVATE
        REAL(psb_dpk_), ALLOCATABLE :: b(:)
    CONTAINS
        PROCEDURE, PUBLIC :: create_pde                   !! Constructor
        PROCEDURE, PUBLIC :: free_pde                     !! Destructor
        PROCEDURE, PUBLIC :: write_scalar_pde
        PROCEDURE, PUBLIC, PASS(pde) :: geins_scalar_pde
        GENERIC, PUBLIC :: geins_pde => geins_scalar_pde  !! Linear System Solving
        PROCEDURE, PUBLIC :: nemo_sizeof
        PROCEDURE, PUBLIC :: reinit_pde
        PROCEDURE, PUBLIC :: asb_pde_
        PROCEDURE, PRIVATE :: solve_scalar_pde
        GENERIC, PUBLIC :: solve_pde => solve_scalar_pde
    END TYPE scalar_pde

scalar_pde Derived Type

Contents

Variables

Type-Bound Procedures

Source Code

type, public, extends(pde) :: scalar_pde

Inherits

Contents

Variables

Type-Bound Procedures

Source Code

Components

Type-Bound Procedures

procedure, public :: asb_pde_

interface

private module subroutine asb_pde_(eqn) Implementation →

Arguments

procedure, public :: build_pde_prec

interface

private module subroutine build_pde_prec(eqn) Implementation →

Arguments

procedure, public :: create_pde

interface

private module subroutine create_pde(eqn, input_file, sec, msh, dim) Implementation →

Arguments

generic, public :: dim_ => get_pde_dim

private interface get_pde_dim()

Arguments

procedure, public :: free_pde

interface

private module subroutine free_pde(eqn) Implementation →

Arguments

procedure, public :: free_pde_prec

interface

private module subroutine free_pde_prec(eqn) Implementation →

Arguments

generic, public :: geins_pde => geins_scalar_pde

private interface geins_scalar_pde()

Arguments

procedure, public, pass(pde) :: geins_scalar_pde

interface

private module subroutine geins_scalar_pde(n, ia, cloud, pde) Implementation →

Arguments

generic, public :: get_a => get_pde_a

private interface get_pde_a()

Arguments

generic, public :: get_diag => get_pde_diag

private interface get_pde_diag()

Arguments

generic, public :: get_mesh => get_pde_msh_sub

private interface get_pde_msh_sub()

Arguments

procedure, public :: is_pde_asb

interface

private module function is_pde_asb(eqn) Implementation →

Arguments

Return Value logical

procedure, public :: is_pde_bld

interface

private module function is_pde_bld(eqn) Implementation →

Arguments

Return Value logical

generic, public :: msh_ => get_pde_msh_fun

private interface get_pde_msh_fun()

Arguments

generic, public :: name_ => get_pde_name

private interface get_pde_name()

Arguments

procedure, public :: nemo_sizeof

interface

private module function nemo_sizeof(eqn) Implementation →

Arguments

Return Value integer(kind=nemo_int_long_)

procedure, public :: reinit_pde

interface

private module subroutine reinit_pde(eqn) Implementation →

Arguments

generic, public :: solve_pde => solve_scalar_pde

private interface solve_scalar_pde()

Arguments

private module subroutine asb_pde_(eqn)

private module subroutine build_pde_prec(eqn)

private module subroutine create_pde(eqn, input_file, sec, msh, dim)

private module subroutine free_pde(eqn)

private module subroutine free_pde_prec(eqn)

private module subroutine geins_scalar_pde(n, ia, cloud, pde)

private module function is_pde_asb(eqn)

private module function is_pde_bld(eqn)

private module function nemo_sizeof(eqn)

private module subroutine reinit_pde(eqn)

private module subroutine solve_pde_sys(eqn, b, x, iter, err)

private module subroutine spins_pde(n, ia, ja, cloud, eqn)

private module subroutine write_pde(eqn, mat, mtx_rhs)

private module subroutine write_scalar_pde(eqn, mat, rhs)

private module subroutine solve_scalar_pde(pde, mats, phi, var)