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
• compute_fwl_factor

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
layer	logical		Layer flags for each side (-x, +x, -y, +y, -z, +z).
width	real(kind=R8P)		Requested physical layer width.
C	integer(kind=I4P)	allocatable	Derived layer width in cells for each block/face [nb,6].
ni_fWL	integer(kind=I4P)	allocatable	FWL bounds for each block/face [2,nb,6].
nj_fWL	integer(kind=I4P)	allocatable	FWL bounds for each block/face [2,nb,6].
nk_fWL	integer(kind=I4P)	allocatable	FWL bounds for each block/face [2,nb,6].
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).

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, field, grid, tree, file_parameters, physics)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_fWLayer_object)	inout		fWLayer.
field	type(field_object)	in		Field (sibling realm component, threaded in).
grid	type(grid_object)	in		Grid (sibling realm component, threaded in).
tree	type(tree_object)	in		Tree (sibling realm component, threaded in).
file_parameters	type(file_ini)	in		Simulation parameters ini file handler.
physics	type(prism_physics_object)	in		Physics.

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, C, ni_fWL, nj_fWL, nk_fWL, n, s2, alfa_D, beta_D, alfa_B, beta_B, dxyz, q)

Arguments

Name	Type	Intent	Attributes	Description
blocks_number	integer(kind=I4P)	in		Blocks number.
ngc	integer(kind=I4P)	in		Number of ghost cells.
C	integer(kind=I4P)	in		Layer width in cells for each block on the current face.
ni_fWL	integer(kind=I4P)	in		FWL bounds for each block on the current face.
nj_fWL	integer(kind=I4P)	in		FWL bounds for each block on the current face.
nk_fWL	integer(kind=I4P)	in		FWL bounds for each block on the current face.
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).
dxyz	real(kind=R8P)	in		Block mesh spacing [3,nb].
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

compute_fwl_factor

Return the local fWLayer damping factor for a cell at integer offset from the boundary.

Attributes: pure

Returns: real(kind=r8p)

function compute_fwl_factor(offset, cells_number, ds) result(f_value)

Arguments

Name	Type	Intent	Attributes	Description
offset	integer(kind=I4P)	in		Cell offset from the boundary, 0 at the boundary cell.
cells_number	integer(kind=I4P)	in		Layer thickness in cells.
ds	real(kind=R8P)	in		Cell size along the layer-normal direction.

Call graph