adam_prism_fWLayer_object

Source: src/app/prism/common/adam_prism_fWLayer_object.F90

Dependencies

Contents

• prism_fWLayer_object
• initialize
• load_from_file
• apply_fWL_correction_fun
• description

Variables

Name	Type	Attributes	Description
INI_SECTION_NAME	character(len=7)	parameter	INI file section name containing flWLayer datas.

Derived Types

prism_fWLayer_object

PRISM fWLayer class definition.

Components

Name	Type	Attributes	Description
mpih	type(mpih_object)		MPI handler.
layer	logical		Layer flags for each side (-x, +x, -y, +y, -z, +z).
C	integer(kind=I4P)		Layer cell width.
ni_fWL	integer(kind=I4P)		Dimensions of FWL domain.
nj_fWL	integer(kind=I4P)		Dimensions of FWL domain.
nk_fWL	integer(kind=I4P)		Dimensions of FWL domain.
s2	real(kind=R8P)		Side coefficient.
n	integer(kind=I4P)		FWL f function index.
alfa_D	integer(kind=I4P)		Corrected var index of D (Barbas' notation).
beta_D	integer(kind=I4P)		Corrected var index of D (Barbas' notation).
alfa_B	integer(kind=I4P)		Corrected var index of B (Barbas' notation).
beta_B	integer(kind=I4P)		Corrected var index of B (Barbas' notation).
f	real(kind=R8P)	allocatable	fWLayer function values.

Type-Bound Procedures

Name	Attributes	Description
description	pass(self)	Return pretty-printed object description.
initialize	pass(self)	Initialize physics.
load_from_file	pass(self)	Load config from file.

Subroutines

initialize

Initialize the fWLayer.

subroutine initialize(self, file_parameters, physics, field)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_fWLayer_object)	inout		fWLayer.
file_parameters	type(file_ini)	in		Simulation parameters ini file handler.
physics	type(prism_physics_object)	in		Physics.
field	type(field_object)	in		Field.

Call graph

load_from_file

Load config from file.

subroutine load_from_file(self, file_parameters, go_on_fail)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_fWLayer_object)	inout		Physics.
file_parameters	type(file_ini)	in		Simulation parameters ini file handler.
go_on_fail	logical	in	optional	Go on if load fails.

Call graph

apply_fWL_correction_fun

Applay FWL correction, direction agnostic.

subroutine apply_fWL_correction_fun(blocks_number, ngc, ni1, ni2, nj1, nj2, nk1, nk2, n, s2, alfa_D, beta_D, alfa_B, beta_B, f, q)

Arguments

Name	Type	Intent	Attributes	Description
blocks_number	integer(kind=I4P)	in		Blocks number.
ngc	integer(kind=I4P)	in		Number of ghost cells.
ni1	integer(kind=I4P)	in		Dimensions of FWL domain.
ni2	integer(kind=I4P)	in		Dimensions of FWL domain.
nj1	integer(kind=I4P)	in		Dimensions of FWL domain.
nj2	integer(kind=I4P)	in		Dimensions of FWL domain.
nk1	integer(kind=I4P)	in		Dimensions of FWL domain.
nk2	integer(kind=I4P)	in		Dimensions of FWL domain.
n	integer(kind=I4P)	in		f component.
s2	real(kind=R8P)	in		Side coefficient.
alfa_D	integer(kind=I4P)	in		Corrected var index of D (Barbas' notation).
beta_D	integer(kind=I4P)	in		Corrected var index of D (Barbas' notation).
alfa_B	integer(kind=I4P)	in		Corrected var index of D (Barbas' notation).
beta_B	integer(kind=I4P)	in		Corrected var index of D (Barbas' notation).
f	real(kind=R8P)	in		fWLayer function values.
q	real(kind=R8P)	inout		Field variables.

Call graph

Functions

description

Return a pretty-formatted object description.

Returns: character(len=:)

function description(self) result(desc)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_fWLayer_object)	in		Physics.

Call graph