grid_function_implementation Submodule

The implementation of the interfaces defined in grid_function.

Uses

- Ancestors:
- grid_function
Help
Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Module Procedures

module procedure init_rgf module function init_rgf(n, order, var_name)

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=ip),	intent(in)			::	n	The number of elements in this grid function.
integer(kind=ip),	intent(in)			::	order	The order of the elements in this grid function.
character(len=*),	intent(in)			::	var_name	The name to be assigned to this grid function.

Return Value type(rgf)

The return type has to be of type rgf.

module procedure output_rgf module subroutine output_rgf(this, coord)

Arguments

Type	Intent	Optional	Attributes		Name
class(rgf),	intent(inout)			::	this	Has to be called with an rgf class.
type(rgf),	intent(in)			::	coord	A real grid function that contains the coordinates.

module procedure deallocate_rgf module subroutine deallocate_rgf(this)

Arguments

Type	Intent	Optional	Attributes		Name
type(rgf)				::	this	Has to be called with an rgf class.

module procedure init_cgf module function init_cgf(n, order, var_name)

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=ip),	intent(in)			::	n	The number of elements in this grid function.
integer(kind=ip),	intent(in)			::	order	The order of the elements in this grid function.
character(len=*),	intent(in)			::	var_name	The name to be assigned to this grid function.

Return Value type(cgf)

The return type has to be of type cgf.

module procedure output_cgf module subroutine output_cgf(this, coord)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	Has to be called with an cgf class.
type(rgf),	intent(in)			::	coord	A real grid function that contains the coordinates.

module procedure deallocate_cgf module subroutine deallocate_cgf(this)

Arguments

Type	Intent	Optional	Attributes		Name
type(cgf)				::	this	The object to finalize

module procedure init_igfb module function init_igfb(n, var_name)

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=ip),	intent(in)			::	n	The number of elements.
character(len=*),	intent(in)			::	var_name	The name of the object.

Return Value type(igfb)

The object to construct.

module procedure output_igfb module subroutine output_igfb(this, coord)

Arguments

Type	Intent	Optional	Attributes		Name
class(igfb),	intent(inout)			::	this	The routine is called on this object.
type(rgf),	intent(in)			::	coord	A real grid function that contains the coordinates.

module procedure deallocate_igfb module subroutine deallocate_igfb(this)

Arguments

Type	Intent	Optional	Attributes		Name
type(igfb)				::	this	The object to finalize.

module procedure init_rgfb module function init_rgfb(n, var_name)

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=ip),	intent(in)			::	n	The number of elements.
character(len=*),	intent(in)			::	var_name	The name of the object.

Return Value type(rgfb)

The object to construct.

module procedure output_rgfb module subroutine output_rgfb(this, coord)

Arguments

Type	Intent	Optional	Attributes		Name
class(rgfb),	intent(inout)			::	this	The routine is called on this object.
type(rgf),	intent(in)			::	coord	A real grid function that contains the coordinates.

module procedure deallocate_rgfb module subroutine deallocate_rgfb(this)

Arguments

Type	Intent	Optional	Attributes		Name
type(rgfb)				::	this	The object to finalize.

module procedure init_cgfb module function init_cgfb(n, var_name)

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=ip),	intent(in)			::	n	The number of elements.
character(len=*),	intent(in)			::	var_name	The name of the object.

Return Value type(cgfb)

The object to construct.

module procedure output_cgfb module subroutine output_cgfb(this, coord)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgfb),	intent(inout)			::	this	The routine is called on this object.
type(rgf),	intent(in)			::	coord	A real grid function that contains the coordinates.

module procedure mult_sc_cgf module subroutine mult_sc_cgf(this, scalar)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
real(kind=wp),	intent(in)			::	scalar	The scalar to multiply with.

module procedure sc_mult_gf_cgf module subroutine sc_mult_gf_cgf(this, scalar, gf)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
real(kind=wp),	intent(in)			::	scalar	The scalar to multiply with.
class(cgf),	intent(in)			::	gf	The grid function to multiply with.

module procedure copy_cgf module subroutine copy_cgf(this, gf)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
class(cgf),	intent(in)			::	gf	The grid function to copy.

module procedure zero_cgf module subroutine zero_cgf(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.

module procedure add_gf_cgf module subroutine add_gf_cgf(this, gf)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
class(cgf),	intent(in)			::	gf	The grid function to add.

module procedure add_sc_mult_gf_cgf module subroutine add_sc_mult_gf_cgf(this, scalar, gf)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
real(kind=wp),	intent(in)			::	scalar	The scalar to multiply with.
class(cgf),	intent(in)			::	gf	The second grid function.

module procedure mult_sc_add_sc_mult_gf_cgf module subroutine mult_sc_add_sc_mult_gf_cgf(this, scalar1, scalar2, gf)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
real(kind=wp),	intent(in)			::	scalar1	The first scalar.
real(kind=wp),	intent(in)			::	scalar2	The second scalar.
class(cgf),	intent(in)			::	gf	The second grid function.

module procedure gf1_plus_sc_mult_gf2_cgf module subroutine gf1_plus_sc_mult_gf2_cgf(this, gf1, scalar, gf2)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
class(cgf),	intent(in)			::	gf1	The second grid function.
real(kind=wp),	intent(in)			::	scalar	The scalar.
class(cgf),	intent(in)			::	gf2	The third grid function.

module procedure sc_mult_gf1_plus_sc_mult_gf2_cgf module subroutine sc_mult_gf1_plus_sc_mult_gf2_cgf(this, gf1, scalar1, gf2, scalar2)

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
class(cgf),	intent(in)			::	gf1	The second grid function.
real(kind=wp),	intent(in)			::	scalar1	The first scalar.
class(cgf),	intent(in)			::	gf2	The third grid function.
real(kind=wp),	intent(in)			::	scalar2	The second scalar.

module procedure deallocate_cgfb module subroutine deallocate_cgfb(this)

Arguments

Type	Intent	Optional	Attributes		Name
type(cgfb)				::	this	The object to finalize.