adam_prism_grms_object

ADAM, PRISM Grms diagnostic object.

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

Dependencies

Contents

• prism_grms_object
• initialize
• load_from_file
• save_history

Variables

Name	Type	Attributes	Description
GRMS_SECTION_NAME	character(len=4)	parameter

Derived Types

prism_grms_object

PRISM Grms diagnostic configuration and history writer.

Components

Name	Type	Attributes	Description
do_save_history	logical		Enable Grms history output.
history_save	integer(kind=I4P)		Grms history output cadence.
history_unit	integer(kind=I4P)		Grms history file unit.
use_cylindrical_region	logical		Restrict the diagnostic to an input cylinder.
center	real(kind=R8P)		Cylinder center.
axis	real(kind=R8P)		Cylinder axis, normalized at load time.
radius	real(kind=R8P)		Cylinder radius.
length	real(kind=R8P)		Cylinder length.
output_basename	character(len=:)	allocatable	Basename of output files.
grms_domain_B	real(kind=R8P)		Grms over the selected domain.
grms_3db_B	real(kind=R8P)		Grms over the -3 dB subset of the selected domain.
reference_B	real(kind=R8P)		Reference rotating magnetic field amplitude.
threshold_B	real(kind=R8P)		-3 dB threshold amplitude.
domain_measure	real(kind=R8P)		Measure of the selected domain.
measure_3db	real(kind=R8P)		Measure of the -3 dB subset.
domain_cells_number	integer(kind=I8P)		Number of cells in the selected domain.
cells_number_3db	integer(kind=I8P)		Number of cells in the -3 dB subset.

Type-Bound Procedures

Name	Attributes	Description
initialize	pass(self)
load_from_file	pass(self)
save_history	pass(self)

Subroutines

initialize

Initialize the Grms diagnostic.

subroutine initialize(self, file_parameters, output_basename, verbose)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_grms_object)	inout
file_parameters	type(file_ini)	in
output_basename	character(len=*)	in
verbose	logical	in	optional

Call graph

load_from_file

Load Grms config from the shared input file.

subroutine load_from_file(self, file_parameters, go_on_fail)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_grms_object)	inout
file_parameters	type(file_ini)	in
go_on_fail	logical	in	optional

Call graph

save_history

Save Grms history.

subroutine save_history(self, it, time, blocks_number, is_to_open, is_to_close)

Arguments

Name	Type	Intent	Attributes	Description
self	class(prism_grms_object)	inout
it	integer(kind=I4P)	in
time	real(kind=R8P)	in
blocks_number	integer(kind=I4P)	in
is_to_open	logical	in	optional
is_to_close	logical	in	optional

Call graph