structured_grid_implementation Submodule

Uses

- assertions_interface
- Ancestors:
- structured_grid_interface
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. Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Variables

Type	Visibility	Attributes		Name		Initial
integer,	private,	dimension(:), allocatable	::	global_block_shape

Module Procedures

module procedure clone pure module subroutine clone(this, original)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(inout)			::	this
class(structured_grid),	intent(in)			::	original

module procedure compare pure module subroutine compare(this, reference, tolerance)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this
class(structured_grid),	intent(in)			::	reference
real(kind=r8k),	intent(in)			::	tolerance

module procedure diffusion_coefficient pure module function diffusion_coefficient(this, temperature) result(coefficient)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this
real(kind=r8k),	intent(in)			::	temperature

Return Value real(kind=r8k)

module procedure free_tensor_indices pure module function free_tensor_indices(this) result(num_free_indices)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value integer

module procedure get_block_identifier pure module function get_block_identifier(this) result(this_block_id)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value integer

module procedure get_global_block_shape pure module function get_global_block_shape(this) result(shape_array)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value integer, dimension(:), allocatable

module procedure get_scalar pure module function get_scalar(this) result(scalar_values)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value real(kind=r8k), dimension(:,:,:), allocatable

module procedure get_scalar_identifier pure module function get_scalar_identifier(this) result(this_scalar_id)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value integer

module procedure get_tag pure module function get_tag(this) result(this_tag)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value integer(kind=tag_kind)

module procedure increment_scalar pure module subroutine increment_scalar(this, scalar)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(inout)			::	this
real(kind=r8k),	intent(in),		dimension(:,:,:)	::	scalar

module procedure num_cells elemental module function num_cells(this) result(cell_count)

in each coordinatee direction, there are one fewer cells than grid points

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value integer

module procedure num_time_stamps pure module function num_time_stamps(this) result(num_times)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value integer

module procedure set_block_identifier module subroutine set_block_identifier(this, id)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(inout)			::	this
integer,	intent(in)			::	id

module procedure set_global_block_shape module subroutine set_global_block_shape(this, shape_array)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(inout)			::	this
integer,	intent(in),		dimension(:)	::	shape_array

module procedure set_metadata pure module subroutine set_metadata(this, metadata)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(inout)			::	this
type(block_metadata),	intent(in)			::	metadata

module procedure set_scalar pure module subroutine set_scalar(this, scalar)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(inout)			::	this
real(kind=r8k),	intent(in),		dimension(:,:,:)	::	scalar

module procedure set_scalar_identifier module subroutine set_scalar_identifier(this, id)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(inout)			::	this
integer,	intent(in)			::	id

module procedure set_vector_components pure module subroutine set_vector_components(this, x_nodes, y_nodes, z_nodes)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(inout)			::	this
real(kind=r8k),	intent(in),		dimension(:,:,:)	::	x_nodes
real(kind=r8k),	intent(in),		dimension(:,:,:)	::	y_nodes
real(kind=r8k),	intent(in),		dimension(:,:,:)	::	z_nodes

module procedure space_dimension pure module function space_dimension(this) result(num_dimensions)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value integer

module procedure subtract module function subtract(this, rhs) result(difference)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this
class(structured_grid),	intent(in)			::	rhs

Return Value class(structured_grid), allocatable

module procedure vectors pure module function vectors(this) result(vectors3d)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this

Return Value real(kind=r8k), dimension(:,:,:,:), allocatable

module procedure write_formatted module subroutine write_formatted(this, unit, iotype, v_list, iostat, iomsg)

Arguments

Type	Intent	Optional	Attributes		Name
class(structured_grid),	intent(in)			::	this
integer,	intent(in)			::	unit
character(len=*),	intent(in)			::	iotype
integer,	intent(in)			::	v_list(:)
integer,	intent(out)			::	iostat
character(len=*),	intent(inout)			::	iomsg