This module contains simulation variables. More...

Variables
character(len=linelength)	simfile = 'mfsim.nam'
	simulation name file More...

character(len=linelength)	simlstfile = 'mfsim.lst'
	simulation listing file name More...

character(len=linelength)	simstdout = 'mfsim.stdout'
	name of standard out file if screen output is piped to a file More...

character(len=linelength)	idm_context = '__INPUT__'

character(len=linelength)	simulation_mode = 'SEQUENTIAL'

integer(i4b)	proc_id = 0

integer(i4b)	nr_procs = 1

character(len=lenmodelname), dimension(:), allocatable	model_names
	all model names in the (global) simulation More...

integer(i4b), dimension(:), pointer, contiguous	model_ranks
	all model processor ids (ranks) in the (global) simulation More...

integer(i4b), dimension(:), allocatable	model_loc_idx
	equals the local index into the basemodel list (-1 when not available) More...

character(len=maxcharlen)	errmsg
	error message string More...

character(len=maxcharlen)	warnmsg
	warning message string More...

integer(i4b)	istdout = output_unit
	unit number for stdout More...

integer(i4b)	isim_level = VALL
	simulation output level More...

integer(i4b)	isim_mode = MNORMAL
	simulation mode More...

integer(i4b)	iout
	file unit number for simulation output More...

integer(i4b)	isimcnvg
	simulation convergence flag (1) if all objects have converged, (0) otherwise More...

integer(i4b)	isimcontinue = 0
	simulation continue flag (1) to continue if isimcnvg = 0, (0) to terminate More...

integer(i4b)	isimcheck = 1
	simulation input check flag (1) to check input, (0) to ignore checks More...

integer(i4b)	numnoconverge = 0
	number of times the simulation did not converge More...

integer(i4b)	ireturnerr = 0
	return code for program (0) successful, (1) non-convergence, (2) error More...

integer(i4b)	iforcestop = 1
	forced stop flag (1) forces a call to ustop(..) when the simulation has ended, (0) doesn't More...

integer(i4b)	iunext = IUSTART
	next file unit number to assign More...

integer(i4b)	laststepfailed = 0
	flag indicating if the last step failed (1) if last step failed; (0) otherwise (set in converge_check) More...

integer(i4b)	ifailedstepretry = 0
	current retry for this time step More...

integer(i4b)	iparamlog = 0
	input (idm) parameter logging to simulation listing file More...

Detailed Description

This module contains simulation variables that are available to all other modules. This variables in this module are defined at run time. The module does not have any dependencies on models, exchanges, or solutions in a simulation.

Variable Documentation

◆ errmsg

character(len=maxcharlen) simvariablesmodule::errmsg

Definition at line 28 of file SimVariables.f90.

28 character(len=MAXCHARLEN) :: errmsg !< error message string

◆ idm_context

character(len=linelength) simvariablesmodule::idm_context = '__INPUT__'

Definition at line 18 of file SimVariables.f90.

18 character(len=LINELENGTH) :: idm_context = '__INPUT__'

◆ ifailedstepretry

integer(i4b) simvariablesmodule::ifailedstepretry = 0

Definition at line 42 of file SimVariables.f90.

42 integer(I4B) :: iFailedStepRetry = 0 !< current retry for this time step

◆ iforcestop

integer(i4b) simvariablesmodule::iforcestop = 1

Definition at line 39 of file SimVariables.f90.

39 integer(I4B) :: iforcestop = 1 !< forced stop flag (1) forces a call to ustop(..) when the simulation has ended, (0) doesn't

◆ iout

integer(i4b) simvariablesmodule::iout

Definition at line 33 of file SimVariables.f90.

33 integer(I4B) :: iout !< file unit number for simulation output

◆ iparamlog

integer(i4b) simvariablesmodule::iparamlog = 0

Definition at line 43 of file SimVariables.f90.

43 integer(I4B) :: iparamlog = 0 !< input (idm) parameter logging to simulation listing file

◆ ireturnerr

integer(i4b) simvariablesmodule::ireturnerr = 0

Definition at line 38 of file SimVariables.f90.

38 integer(I4B) :: ireturnerr = 0 !< return code for program (0) successful, (1) non-convergence, (2) error

◆ isim_level

integer(i4b) simvariablesmodule::isim_level = VALL

Definition at line 31 of file SimVariables.f90.

31 integer(I4B) :: isim_level = vall !< simulation output level

◆ isim_mode

integer(i4b) simvariablesmodule::isim_mode = MNORMAL

Definition at line 32 of file SimVariables.f90.

32 integer(I4B) :: isim_mode = mnormal !< simulation mode

◆ isimcheck

integer(i4b) simvariablesmodule::isimcheck = 1

Definition at line 36 of file SimVariables.f90.

36 integer(I4B) :: isimcheck = 1 !< simulation input check flag (1) to check input, (0) to ignore checks

◆ isimcnvg

integer(i4b) simvariablesmodule::isimcnvg

Definition at line 34 of file SimVariables.f90.

34 integer(I4B) :: isimcnvg !< simulation convergence flag (1) if all objects have converged, (0) otherwise

◆ isimcontinue

integer(i4b) simvariablesmodule::isimcontinue = 0

Definition at line 35 of file SimVariables.f90.

35 integer(I4B) :: isimcontinue = 0 !< simulation continue flag (1) to continue if isimcnvg = 0, (0) to terminate

◆ istdout

integer(i4b) simvariablesmodule::istdout = output_unit

Definition at line 30 of file SimVariables.f90.

30 integer(I4B) :: istdout = output_unit !< unit number for stdout

◆ iunext

integer(i4b) simvariablesmodule::iunext = IUSTART

Definition at line 40 of file SimVariables.f90.

40 integer(I4B) :: iunext = iustart !< next file unit number to assign

◆ laststepfailed

integer(i4b) simvariablesmodule::laststepfailed = 0

Definition at line 41 of file SimVariables.f90.

41 integer(I4B) :: lastStepFailed = 0 !< flag indicating if the last step failed (1) if last step failed; (0) otherwise (set in converge_check)

◆ model_loc_idx

integer(i4b), dimension(:), allocatable simvariablesmodule::model_loc_idx

Definition at line 26 of file SimVariables.f90.

26 integer(I4B), dimension(:), allocatable :: model_loc_idx !< equals the local index into the basemodel list (-1 when not available)

◆ model_names

character(len=lenmodelname), dimension(:), allocatable simvariablesmodule::model_names

Definition at line 24 of file SimVariables.f90.

24 character(len=LENMODELNAME), dimension(:), allocatable :: model_names !< all model names in the (global) simulation

◆ model_ranks

integer(i4b), dimension(:), pointer, contiguous simvariablesmodule::model_ranks

Definition at line 25 of file SimVariables.f90.

25 integer(I4B), dimension(:), pointer, contiguous :: model_ranks !< all model processor ids (ranks) in the (global) simulation

◆ nr_procs

integer(i4b) simvariablesmodule::nr_procs = 1

Definition at line 23 of file SimVariables.f90.

23 integer(I4B) :: nr_procs = 1

◆ numnoconverge

integer(i4b) simvariablesmodule::numnoconverge = 0

Definition at line 37 of file SimVariables.f90.

37 integer(I4B) :: numnoconverge = 0 !< number of times the simulation did not converge

◆ proc_id

integer(i4b) simvariablesmodule::proc_id = 0

Definition at line 22 of file SimVariables.f90.

22 integer(I4B) :: proc_id = 0

◆ simfile

character(len=linelength) simvariablesmodule::simfile = 'mfsim.nam'

Definition at line 15 of file SimVariables.f90.

15 character(len=LINELENGTH) :: simfile = 'mfsim.nam' !< simulation name file

◆ simlstfile

character(len=linelength) simvariablesmodule::simlstfile = 'mfsim.lst'

Definition at line 16 of file SimVariables.f90.

16 character(len=LINELENGTH) :: simlstfile = 'mfsim.lst' !< simulation listing file name

◆ simstdout

character(len=linelength) simvariablesmodule::simstdout = 'mfsim.stdout'

Definition at line 17 of file SimVariables.f90.

17 character(len=LINELENGTH) :: simstdout = 'mfsim.stdout' !< name of standard out file if screen output is piped to a file

◆ simulation_mode

character(len=linelength) simvariablesmodule::simulation_mode = 'SEQUENTIAL'

Definition at line 21 of file SimVariables.f90.

21 character(len=LINELENGTH) :: simulation_mode = 'SEQUENTIAL'

◆ warnmsg

character(len=maxcharlen) simvariablesmodule::warnmsg

Definition at line 29 of file SimVariables.f90.

29 character(len=MAXCHARLEN) :: warnmsg !< warning message string