m_omp_poisson_fft

Uses

- m_field
- m_tdsops
- m_omp_spectral
- m_poisson_fft
- m_mesh
- decomp_2d_constants
- m_common
- decomp_2d_fft
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.

Used by

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.

Interfaces

public interface omp_poisson_fft_t

private function init(mesh, xdirps, ydirps, zdirps, lowmem) result(poisson_fft)

Arguments

Type	Intent	Optional		Name
type(mesh_t),	intent(in)		::	mesh
class(dirps_t),	intent(in)		::	xdirps
class(dirps_t),	intent(in)		::	ydirps
class(dirps_t),	intent(in)		::	zdirps
logical,	intent(in),	optional	::	lowmem

Return Value type(omp_poisson_fft_t)

Derived Types

type, public, extends(poisson_fft_t) :: omp_poisson_fft_t

FFT based Poisson solver

Components

Type	Visibility	Attributes		Name		Initial
integer,	public		::	nx_glob			Global dimensions
integer,	public		::	ny_glob			Global dimensions
integer,	public		::	nz_glob			Global dimensions
integer,	public		::	nx_loc			Local dimensions
integer,	public		::	ny_loc			Local dimensions
integer,	public		::	nz_loc			Local dimensions
integer,	public		::	nx_perm			Local dimensions in the permuted slabs
integer,	public		::	ny_perm			Local dimensions in the permuted slabs
integer,	public		::	nz_perm			Local dimensions in the permuted slabs
integer,	public		::	nx_spec			Local dimensions in the permuted slabs in spectral space
integer,	public		::	ny_spec			Local dimensions in the permuted slabs in spectral space
integer,	public		::	nz_spec			Local dimensions in the permuted slabs in spectral space
integer,	public		::	x_sp_st			Offset in y and z directions in the permuted slabs in spectral space
integer,	public		::	y_sp_st			Offset in y and z directions in the permuted slabs in spectral space
integer,	public		::	z_sp_st			Offset in y and z directions in the permuted slabs in spectral space
complex(kind=dp),	public,	allocatable, dimension(:, :, :)	::	waves			Local domain sized array storing the spectral equivalence constants
real(kind=dp),	public,	allocatable, dimension(:)	::	ax			Wave numbers in x, y, and z
real(kind=dp),	public,	allocatable, dimension(:)	::	bx			Wave numbers in x, y, and z
real(kind=dp),	public,	allocatable, dimension(:)	::	ay			Wave numbers in x, y, and z
real(kind=dp),	public,	allocatable, dimension(:)	::	by			Wave numbers in x, y, and z
real(kind=dp),	public,	allocatable, dimension(:)	::	az			Wave numbers in x, y, and z
real(kind=dp),	public,	allocatable, dimension(:)	::	bz			Wave numbers in x, y, and z
complex(kind=dp),	public,	allocatable, dimension(:)	::	kx			Wave numbers in x, y, and z
complex(kind=dp),	public,	allocatable, dimension(:)	::	ky			Wave numbers in x, y, and z
complex(kind=dp),	public,	allocatable, dimension(:)	::	kz			Wave numbers in x, y, and z
complex(kind=dp),	public,	allocatable, dimension(:)	::	exs			Wave numbers in x, y, and z
complex(kind=dp),	public,	allocatable, dimension(:)	::	eys			Wave numbers in x, y, and z
complex(kind=dp),	public,	allocatable, dimension(:)	::	ezs			Wave numbers in x, y, and z
complex(kind=dp),	public,	allocatable, dimension(:)	::	k2x			Wave numbers in x, y, and z
complex(kind=dp),	public,	allocatable, dimension(:)	::	k2y			Wave numbers in x, y, and z
complex(kind=dp),	public,	allocatable, dimension(:)	::	k2z			Wave numbers in x, y, and z
real(kind=dp),	public,	allocatable, dimension(:)	::	trans_x_re			Staggared grid transformation
real(kind=dp),	public,	allocatable, dimension(:)	::	trans_x_im			Staggared grid transformation
real(kind=dp),	public,	allocatable, dimension(:)	::	trans_y_re			Staggared grid transformation
real(kind=dp),	public,	allocatable, dimension(:)	::	trans_y_im			Staggared grid transformation
real(kind=dp),	public,	allocatable, dimension(:)	::	trans_z_re			Staggared grid transformation
real(kind=dp),	public,	allocatable, dimension(:)	::	trans_z_im			Staggared grid transformation
logical,	public		::	periodic_x			Periodicity in x, y, and z
logical,	public		::	periodic_y			Periodicity in x, y, and z
logical,	public		::	periodic_z			Periodicity in x, y, and z
logical,	public		::	stretched_y	=	.false.	Periodicity in x, y, and z
logical,	public		::	stretched_y_sym			Periodicity in x, y, and z
real(kind=dp),	public,	allocatable, dimension(:, :, :, :)	::	a_odd_re			Stretching operator matrices
real(kind=dp),	public,	allocatable, dimension(:, :, :, :)	::	a_odd_im			Stretching operator matrices
real(kind=dp),	public,	allocatable, dimension(:, :, :, :)	::	a_even_re			Stretching operator matrices
real(kind=dp),	public,	allocatable, dimension(:, :, :, :)	::	a_even_im			Stretching operator matrices
real(kind=dp),	public,	allocatable, dimension(:, :, :, :)	::	a_re			Stretching operator matrices
real(kind=dp),	public,	allocatable, dimension(:, :, :, :)	::	a_im			Stretching operator matrices
logical,	public		::	lowmem	=	.false.	lowmem option, only used in CUDA backend
procedure(poisson_xxx),	public,	pointer	::	poisson	=>	null()	Procedure pointer to BC specific poisson solvers
complex(kind=dp),	public,	allocatable, dimension(:, :, :)	::	c_x
complex(kind=dp),	public,	allocatable, dimension(:, :, :)	::	c_y
complex(kind=dp),	public,	allocatable, dimension(:, :, :)	::	c_z

Constructor

private function init (mesh, xdirps, ydirps, zdirps, lowmem)

Type-Bound Procedures

procedure, public :: base_init
procedure, public :: solve_poisson
procedure, public :: stretching_matrix
procedure, public :: waves_set
procedure, public :: get_km
procedure, public :: get_km_re
procedure, public :: get_km_im
procedure, public :: fft_forward => fft_forward_omp
procedure, public :: fft_backward => fft_backward_omp
procedure, public :: fft_postprocess_000 => fft_postprocess_000_omp
procedure, public :: fft_postprocess_010 => fft_postprocess_010_omp
procedure, public :: enforce_periodicity_y => enforce_periodicity_y_omp
procedure, public :: undo_periodicity_y => undo_periodicity_y_omp

Subroutines

public subroutine fft_forward_omp(self, f_in)

Arguments

Type	Intent	Optional	Attributes		Name
class(omp_poisson_fft_t)				::	self
class(field_t),	intent(in)			::	f_in

public subroutine fft_backward_omp(self, f_out)

Arguments

Type	Intent	Optional	Attributes		Name
class(omp_poisson_fft_t)				::	self
class(field_t),	intent(inout)			::	f_out

public subroutine fft_postprocess_000_omp(self)

Arguments

Type	Intent	Optional	Attributes		Name
class(omp_poisson_fft_t)				::	self

public subroutine fft_postprocess_010_omp(self)

Arguments

Type	Intent	Optional	Attributes		Name
class(omp_poisson_fft_t)				::	self

public subroutine enforce_periodicity_y_omp(self, f_out, f_in)

Arguments

Type	Intent		Name
class(omp_poisson_fft_t)		::	self
class(field_t),	intent(inout)	::	f_out
class(field_t),	intent(in)	::	f_in

public subroutine undo_periodicity_y_omp(self, f_out, f_in)

Arguments

Type	Intent		Name
class(omp_poisson_fft_t)		::	self
class(field_t),	intent(inout)	::	f_out
class(field_t),	intent(in)	::	f_in

m_omp_poisson_fft Module

Contents

Interfaces

Derived Types

Subroutines

Uses

Used by

Interfaces

public interface omp_poisson_fft_t

private function init(mesh, xdirps, ydirps, zdirps, lowmem) result(poisson_fft)

Arguments

Return Value type(omp_poisson_fft_t)

Derived Types

type, public, extends(poisson_fft_t) :: omp_poisson_fft_t

Components

Constructor

Type-Bound Procedures

Subroutines

public subroutine fft_forward_omp(self, f_in)

Arguments

public subroutine fft_backward_omp(self, f_out)

Arguments

public subroutine fft_postprocess_000_omp(self)

Arguments

public subroutine fft_postprocess_010_omp(self)

Arguments

public subroutine enforce_periodicity_y_omp(self, f_out, f_in)

Arguments

public subroutine undo_periodicity_y_omp(self, f_out, f_in)

Arguments