pencil Derived Type

type, public :: pencil

Class that describes information about data layout

Inherited by

Help

Components

Type	Visibility	Attributes		Name		Initial
integer(kind=int8),	public		::	aligned_dim			Position of aligned dimension. For example: X pencil aligned_dim = 1, Z pencil aligned_dim = 3
integer(kind=int8),	public		::	rank			Rank of buffer: 2 or 3
integer(kind=int32),	public,	allocatable	::	starts(:)			Local starts, starting from 0 for both C and Fortran
integer(kind=int32),	public,	allocatable	::	counts(:)			Local counts of data, in elements
logical,	public		::	is_even			Is data evenly distributed across processes

Type-Bound Procedures

procedure, public, pass(self) :: create

Creates pencil

private subroutine create(self, rank, aligned_dim, counts, comms, lstarts, lcounts, order)

Creates pencil

Arguments

Type	Intent	Optional	Attributes		Name
class(pencil),	intent(inout)			::	self	Pencil
integer(kind=int8),	intent(in)			::	rank	Rank of buffer
integer(kind=int8),	intent(in)			::	aligned_dim	Position of aligned dimension
integer(kind=int32),	intent(in)			::	counts(:)	Global counts
type(MPI_Comm),	intent(in)			::	comms(:)	Grid communicators
integer(kind=int32),	intent(in),	optional		::	lstarts(:)	Local starts
integer(kind=int32),	intent(in),	optional		::	lcounts(:)	Local counts
integer(kind=int8),	intent(in),	optional		::	order(:)	Order of dimensions

procedure, public, pass(self) :: destroy

Destroys pencil

private subroutine destroy(self)

Destroys pencil

Arguments

Type	Intent	Optional	Attributes		Name
class(pencil),	intent(inout)			::	self	Pencil

procedure, public, pass(self) :: make_public

Creates public object that users can use to create own FFT backends

private function make_public(self)

Creates public object that users can use to create own FFT backends

Arguments

Type	Intent	Optional	Attributes		Name
class(pencil),	intent(in)			::	self	Pencil

Return Value type(dtfft_pencil_t)