adam_patch_time_object

ADAM, PATCH time handler class definition, common CPU backend.

Source: src/app/patch/common/adam_patch_time_object.F90

Dependencies

Contents

• patch_time_object
• initialize
• load_from_file
• print_progress
• description
• is_to_save

Variables

Name	Type	Attributes	Description
INI_SECTION_NAME	character(len=4)	parameter	INI (config) file section name containing time configs.

Derived Types

patch_time_object

PATCH time handler class definition, CPU backend.

Components

Name	Type	Attributes	Description
mpih	type(mpih_object)		MPI handler.
it_max	integer(kind=I4P)		Maximum number of integration time steps.
time_max	real(kind=R8P)		Maximum integration time.
CFL	real(kind=R8P)		CFL time limit.
it	integer(kind=I4P)		Time steps counter.
time	real(kind=R8P)		Time.
dt	real(kind=R8P)		Maximum time step accordingly to CFL criterion.

Type-Bound Procedures

Name	Attributes	Description
description	pass(self)	Return pretty-printed object description.
initialize	pass(self)	Initialize time handler.
is_to_save	pass(self)	Return true if data are to save.
load_from_file	pass(self)	Load config from file.
print_progress	pass(self)	Print simulation progress.

Subroutines

initialize

Initialize time handler.

subroutine initialize(self, file_parameters)

Arguments

Name	Type	Intent	Attributes	Description
self	class(patch_time_object)	inout		Time handler.
file_parameters	type(file_ini)	in		Simulation parameters ini file handler.

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(patch_time_object)	inout		Time handler.
file_parameters	type(file_ini)	in		Simulation parameters ini file handler.
go_on_fail	logical	in	optional	Go on if load fails.

Call graph

print_progress

Print simulation progress.

subroutine print_progress(self, nodes_number)

Arguments

Name	Type	Intent	Attributes	Description
self	class(patch_time_object)	in		Time handler.
nodes_number	integer(kind=I4P)	in		Nodes number, global blocks number.

Call graph

Functions

description

Return a pretty-formatted object description.

Attributes: pure

Returns: character(len=:)

function description(self) result(desc)

Arguments

Name	Type	Intent	Attributes	Description
self	class(patch_time_object)	in		Time handler.

Call graph

is_to_save

Return true if slices are to save.

Returns: logical

function is_to_save(self, it_save)

Arguments

Name	Type	Intent	Attributes	Description
self	class(patch_time_object)	inout		Time handler.
it_save	integer(kind=I4P)	in		Save iterations frequency.

Call graph