omp_poisson_fft_t

type, public, extends(poisson_fft_t) :: omp_poisson_fft_t

FFT based Poisson solver

Inherits

Help

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

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)

Type-Bound Procedures

procedure, public :: base_init

public subroutine base_init(self, mesh, xdirps, ydirps, zdirps, n_spec, n_sp_st)

Arguments

Type	Intent	Attributes		Name
class(poisson_fft_t)			::	self
type(mesh_t),	intent(in)		::	mesh
type(dirps_t),	intent(in)		::	xdirps
type(dirps_t),	intent(in)		::	ydirps
type(dirps_t),	intent(in)		::	zdirps
integer,	intent(in),	dimension(3)	::	n_spec
integer,	intent(in),	dimension(3)	::	n_sp_st

procedure, public :: solve_poisson

public subroutine solve_poisson(self, f, temp)

Arguments

Type	Intent		Name
class(poisson_fft_t)		::	self
class(field_t),	intent(inout)	::	f
class(field_t),	intent(inout)	::	temp

procedure, public :: stretching_matrix

public subroutine stretching_matrix(self, geo, xdirps, ydirps, zdirps)

Stretching necessitates a special operation in spectral space. The coefficients for the operation are stored in matrix form.

Arguments

Type	Intent		Name
class(poisson_fft_t)		::	self
type(geo_t),	intent(in)	::	geo
type(dirps_t),	intent(in)	::	xdirps
type(dirps_t),	intent(in)	::	ydirps
type(dirps_t),	intent(in)	::	zdirps

procedure, public :: waves_set

public subroutine waves_set(self, geo, xdirps, ydirps, zdirps)

Spectral equivalence constants

Arguments

Type	Intent		Name
class(poisson_fft_t)		::	self
type(geo_t),	intent(in)	::	geo
type(dirps_t),	intent(in)	::	xdirps
type(dirps_t),	intent(in)	::	ydirps
type(dirps_t),	intent(in)	::	zdirps

procedure, public :: get_km

public function get_km(self, i, j, k) result(km)

Arguments

Type	Intent		Name
class(poisson_fft_t)		::	self
integer,	intent(in)	::	i
integer,	intent(in)	::	j
integer,	intent(in)	::	k

Return Value complex(kind=dp)

procedure, public :: get_km_re

public function get_km_re(self, i, j, k) result(re)

Arguments

Type	Intent		Name
class(poisson_fft_t)		::	self
integer,	intent(in)	::	i
integer,	intent(in)	::	j
integer,	intent(in)	::	k

Return Value real(kind=dp)

procedure, public :: get_km_im

public function get_km_im(self, i, j, k) result(re)

Arguments

Type	Intent		Name
class(poisson_fft_t)		::	self
integer,	intent(in)	::	i
integer,	intent(in)	::	j
integer,	intent(in)	::	k

Return Value real(kind=dp)

procedure, public :: fft_forward => fft_forward_omp

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

procedure, public :: fft_backward => fft_backward_omp

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

procedure, public :: fft_postprocess_000 => fft_postprocess_000_omp

public subroutine fft_postprocess_000_omp(self)

Arguments

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

procedure, public :: fft_postprocess_010 => fft_postprocess_010_omp

public subroutine fft_postprocess_010_omp(self)

Arguments

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

procedure, public :: enforce_periodicity_y => enforce_periodicity_y_omp

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

procedure, public :: undo_periodicity_y => undo_periodicity_y_omp

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

omp_poisson_fft_t Derived Type

Contents

Variables

Constructor

Type-Bound Procedures

type, public, extends(poisson_fft_t) :: omp_poisson_fft_t

Inherits

Components

Constructor

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)

Type-Bound Procedures

procedure, public :: base_init

public subroutine base_init(self, mesh, xdirps, ydirps, zdirps, n_spec, n_sp_st)

Arguments

procedure, public :: solve_poisson

public subroutine solve_poisson(self, f, temp)

Arguments

procedure, public :: stretching_matrix

public subroutine stretching_matrix(self, geo, xdirps, ydirps, zdirps)

Arguments

procedure, public :: waves_set

public subroutine waves_set(self, geo, xdirps, ydirps, zdirps)

Arguments

procedure, public :: get_km

public function get_km(self, i, j, k) result(km)

Arguments

Return Value complex(kind=dp)

procedure, public :: get_km_re

public function get_km_re(self, i, j, k) result(re)

Arguments

Return Value real(kind=dp)

procedure, public :: get_km_im

public function get_km_im(self, i, j, k) result(re)

Arguments

Return Value real(kind=dp)

procedure, public :: fft_forward => fft_forward_omp

public subroutine fft_forward_omp(self, f_in)

Arguments

procedure, public :: fft_backward => fft_backward_omp

public subroutine fft_backward_omp(self, f_out)

Arguments

procedure, public :: fft_postprocess_000 => fft_postprocess_000_omp

public subroutine fft_postprocess_000_omp(self)

Arguments

procedure, public :: fft_postprocess_010 => fft_postprocess_010_omp

public subroutine fft_postprocess_010_omp(self)

Arguments

procedure, public :: enforce_periodicity_y => enforce_periodicity_y_omp

public subroutine enforce_periodicity_y_omp(self, f_out, f_in)

Arguments

procedure, public :: undo_periodicity_y => undo_periodicity_y_omp

public subroutine undo_periodicity_y_omp(self, f_out, f_in)

Arguments