env_module – Treelm

Definitions and routines to help deployment in the environment of the hosting system.

Todo

: Should generate MPI infos during the build phase in waf.

Uses

Help
Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Used by

env_module		w	bin_search_test
		w
		w	elem_memAlloc
		w
		w	hvs_ascii_module
		w
		w	hvs_aux_module
		w
		w	hvs_base64_module
		w
		w	hvs_output_module
		w
		w	hvs_vtk_module
		w
		w	hvs_vtk_module
		w
		w	hvs_vtk_type_module
		w
		w	tem_abortCriteria_module
		w
		w	tem_acoustic_pulse_module
		w
		w	tem_adaptation_module
		w
		w	tem_arrayofarrays_module
		w
		w	tem_aux_module
		w
		w	tem_balance_module
		w
		w	tem_bc_header_module
		w
		w	tem_bc_module
		w
		w	tem_bc_prop_module
		w
		w	tem_box_module
		w
		w	tem_canonicalND_module
		w
		w	tem_color_prop_module
		w
		w	tem_comm_module
		w
		w	tem_condition_module
		w
		w	tem_construction_module
		w
		w	tem_construction_test
		w
		w	tem_convergence_module
		w
		w	tem_coupling_module
		w
		w	tem_cube_module
		w
		w	tem_cylinder_module
		w
		w	tem_cylindricalWave_module
		w
		w	tem_cylindricalWave_module
		w
		w	tem_debug_module
		w
	w	tem_depend_module
	w
	w	tem_dyn_array_module
	w
	w	tem_dynArray_test
	w
	w	tem_element_module
	w
	w	tem_ellipsoid_module
	w
	w	tem_face_module
	w
	w	tem_face_test
	w
	w	tem_face_test
	w
	w	tem_face_test
	w
	w	tem_faceData_module
	w
	w	tem_float_module
	w
	w	tem_float_test
	w
	w	tem_general_module
	w
	w	tem_geometry_module
	w
	w	tem_global_module
	w
	w	tem_grow_array_module
	w
	w	tem_growArray_test
	w
	w	tem_heaviside_gibbs_fun_module
	w
	w	tem_ic_predefs_module
	w
	w	tem_ini_condition_module
	w
	w	tem_intersection_module
	w
	w	tem_isNaN_module
	w
	w	tem_line_module
	w
	w	tem_logging_module
	w
	w	tem_logical_operation_var_module
	w
	w	tem_logical_opertor_test
	w
	w	tem_lua_requires_module
	w
	w	tem_math_module
	w
	w	tem_matrix_module
	w
	w	tem_mergesort_module
	w
	w	tem_meshInfo_module
	w
	w	tem_miescatter_module
	w
	w	tem_miescatter_module
	w
	w	tem_operation_module
	w
	w	tem_operation_var_module
	w
	w	tem_param_module
	w
	w	tem_path_array_module
	w
	w	tem_plane_module
	w
	w	tem_pmlLayer_module
	w
	w	tem_point_module
	w
	w	tem_pointData_module
	w
	w	tem_polygon_material_module
	w
	w	tem_probing_module
	w
	w	tem_property_module
	w
	w	tem_prophead_module
	w
	w	tem_reduction_spatial_module
	w
	w	tem_reduction_transient_module
	w
	w	tem_refining_module
	w
	w	tem_restart_module
	w
	w	tem_shape_module
	w
	w	tem_simControl_module
	w
	w	tem_solveHead_module
	w
	w	tem_spacetime_fun_module
	w
	w	tem_spacetime_fun_test
	w
	w	tem_spacetime_var_module
	w
	w	tem_Sparta_module
	w
	w	tem_sparta_test
	w
	w	tem_spatial_module
	w
	w	tem_sphere_module
	w
	w	tem_spongeLayer_module
	w
	w	tem_stencil_module
	w
	w	tem_stl_module
	w
	w	tem_stlb_io_module
	w
	w	tem_stringKeyValuePair_module
	w
	w	tem_subres_prop_module
	w
	w	tem_subTree_module
	w
	w	tem_subTree_type_module
	w
	w	tem_surfaceData_module
	w
	w	tem_temporal_module
	w
	w	tem_time_module
	w
	w	tem_timeControl_module
	w
	w	tem_timer_module
	w
	w	tem_tools_module
	w
	w	tem_tools_test
	w
	w	tem_topology_module
	w
	w	tem_tracking_module
	w
	w	tem_tracking_test
	w
	w	tem_trackmem_module
	w
	w	tem_transformation_module
	w
	w	tem_triangle_module
	w
	w	tem_variable_combine_Test
	w
	w	tem_variable_evaltype_test
	w
	w	tem_variable_extract_test
	w
	w	tem_variable_module
	w
	w	tem_varMap_module
	w
	w	tem_varSys_deriveVar_test
	w
	w	tem_varSys_module
	w
	w	tem_varSys_opVar_test
	w
	w	tem_varSys_stateVar_test
	w
	w	tem_varSys_stfunVar_test
	w
	w	tem_varSys_test
	w
	w	tem_vrtx_module
	w
	w	treelmesh_module
	w

Help

Functions

newunit Sys_is_Little_Endian tem_create_EndianSuffix my_status_string my_status_string_vec my_status_int my_status_int_vec

Subroutines

init_env init_random_seed fin_env tem_load_env_params print_self_status tem_connect_toNull

Variables

Type	Visibility	Attributes		Name		Initial
integer,	public,	parameter	::	minLength	=	1	Minimal number of entries in growing/dynamic array
integer,	public,	parameter	::	zeroLength	=	0
integer,	public,	parameter	::	single_prec	=	6	Number of digits for single precision numbers
integer,	public,	parameter	::	double_prec	=	15	Number of digits for double precision numbers
integer,	public,	parameter	::	xdble_prec	=	18	Number of digits for extended double precision numbers
integer,	public,	parameter	::	quad_prec	=	33	Number of digits for quadruple precision numbers
integer,	public,	parameter	::	long_prec	=	15	Number of digits for long integer numbers
integer,	public,	parameter	::	int_prec	=	6	Number of digits for normal long integer numbers
integer,	public,	parameter	::	rk_prec	=	double_prec	If the default precision of reals is to be changed, use this parameter. The real kind (rk will then be selected accordingly). For your convenience there are two predefined parameters available, to select single or double precision: double_prec and single_prec.
integer,	public,	parameter	::	rk	=	selected_real_kind(rk_prec)	The kind to select for default reals
integer,	public,	parameter	::	quad_k	=	selected_real_kind(quad_prec)	The kind to select for reals using quadruple-precision
integer,	public,	parameter	::	double_k	=	selected_real_kind(double_prec)	The kind to select for reals using double-precision
integer,	public,	parameter	::	single_k	=	selected_real_kind(single_prec)	The kind to select for reals using single-precision
integer,	public,	parameter	::	long_k	=	selected_int_kind(long_prec)	The kind to select for default long integers
integer,	public,	parameter	::	int_k	=	selected_int_kind(int_prec)	The kind to select for default normal length integers
real(kind=rk),	public,	parameter	::	eps	=	epsilon(1._rk)	machine error for selected real kind, rk
real(kind=rk),	public,	parameter	::	zero_rk	=	1024*tiny(1._rk)	close value to 0, rk
real(kind=rk),	public,	parameter	::	eps_single_k	=	epsilon(1.0_single_k)	machine error for selected real kind, single_k
integer,	public,	parameter	::	LabelLen	=	80	Length for labels describing selectable options, like names of boundary or initial conditions.
integer,	public,	parameter	::	PathLen	=	800	Length for strings describing file system paths.
integer,	public,	parameter	::	OutLen	=	1024	Length for data strings dumped to file in output routines e.g. ASCII output (1kb).
integer,	public,	parameter	::	SolSpecLen	=	7198	Length for strings describing the solver specific character (64kb).
integer,	public,	parameter	::	ErrorLen	=	100	Length for MPI I/O errors.
integer,	public,	parameter	::	stdOutUnit	=	output_unit	The default output unit, inherited from the iso_fortran_env module Todo if the iso_fortran_env module is not available, this should be set to the usual 6 during compilation.
integer,	public,	parameter	::	globalMaxLevels	=	20	Maximal level of refinements in the Octree
logical,	public		::	isLittleEndian			Endianness of the system, is going to be determined at runtime in init_env.
character,	public,	parameter	::	pathSep	=	'/'	path seperator of the system
character(len=pathLen),	public		::	null_device	=	'/dev/null'	Name of the null device to use for output to be discarded.
integer,	public		::	rk_mpi			MPI Datatype for the used real kind, set in init_env.
integer,	public		::	long_k_mpi			MPI Datatype for the used long kind, set in init_env.
integer,	public,	save	::	io_buffer_size	=	1048576	Size of Buffer for IO in 8 Byte words. (Use a sane default of 8 MB)
logical,	public,	save	::	printRuntimeInfo	=	.true.	Should the information on the runtime obtained from /proc/self/status be printed during finalize? If this Linux pseudo file is not accessible on the current system, a reporting message will be printed instead. The data will only be printed by the first process and thus only shows its state in parallel runs.
integer,	public,	parameter	::	tem_err_fatal	=	0	Some parameters for the error handling. They indicate the bits to set in case of the corresponding error, to allow appropiate reactions of the calling application.
integer,	public,	parameter	::	tem_err_warning	=	1

Functions

public function newunit() result(nu)

Helper function to provide new unit, as long as F2008 newunit argument in open statement is not commonly available. To be used right in front of the open statement like this: myUnit = newunit() open(myUnit, ...)

Arguments

None

Return Value integer

public function Sys_is_Little_Endian() result(endian)

Determine if the system is little or big endian

Arguments

None

Return Value logical

public function tem_create_EndianSuffix() result(suffix)

This function returns the string in the line which starts with the specified key string in the text returned from print_self_status. The key string itself is excluded from the returned string. If the specified key is not found in the text an empty string will be returned.

Arguments

None

Return Value character(len=4)

public function my_status_string(key, info) result(val)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	key
character(len=*),	intent(in),	optional		::	info

Return Value character(len=80)

public function my_status_string_vec(key, info) result(val)

This function returns the strings in the first line which starts with the specified key strings in the text returned from print_self_status.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	key(:)
character(len=*),	intent(in),	optional		::	info

Return Value character(len=80)(size(key))

public function my_status_int(key, info, def) result(val)

Read out the first integer in the line matched by the specified key in the text provided by print_self_status. The key should include all text in front of the integer. For example the peak memory consumption up to now could be extracted with: peakval = my_status_int('VmPeak:') If the key is not found 0 or the optionally defined value in def will be returned.

Arguments

Type	Intent	Optional		Name
character(len=*),	intent(in)		::	key
character(len=*),	intent(in),	optional	::	info
integer,	intent(in),	optional	::	def

Return Value integer

public function my_status_int_vec(key, info, def) result(val)

Reads out the first integer in the line matched by the specified key in the text provided by print_self_status. The key should include all text in front of the integer. For example the peak memory consumption up to now could be extracted with: peakval = my_status_int('VmPeak:') If the key is not found 0 or the optionally defined value in def will be returned.

Arguments

Type	Intent	Optional		Name
character(len=*),	intent(in)		::	key(:)
character(len=*),	intent(in),	optional	::	info
integer,	intent(in),	optional	::	def(:)

Return Value integer(size(key))

Subroutines

public subroutine init_env()

Initialize the environment, should be the very first call in the program and includes the call of MPI_Init.

Arguments

None

public subroutine init_random_seed(idx)

Initialized random seed with idx

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(in)			::	idx

public subroutine fin_env()

Finalize the environment, should be the very last call in the program, and includes the call of MPI_Finalize.

Arguments

None

public subroutine tem_load_env_params(conf)

Load globally configurable environment parameters from the config script

Arguments

Type	Intent	Optional	Attributes		Name
type(flu_State)				::	conf	lua state to load information from

public subroutine print_self_status(unit, info, text)

This subroutine reads out the status of the process if it is available in /proc/self/status, which is provided by the Linux operating system.

Arguments

Type	Intent	Optional		Name
integer,	intent(in),	optional	::	unit	A preconnected unit, to write the content of /proc/self/status to.
character(len=*),	intent(in),	optional	::	info	optional filename prefix
character(len=*),	intent(in),	optional	::	text	optional header text to be dumped to file

public subroutine tem_connect_toNull(null_unit)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(out)			::	null_unit

env_module Module

Contents

Variables

Functions

Subroutines

Todo

Uses

Used by

Contents

Variables

Functions

Subroutines

Variables

Todo

Functions

public function newunit() result(nu)

Arguments

Return Value integer

public function Sys_is_Little_Endian() result(endian)

Arguments

Return Value logical

public function tem_create_EndianSuffix() result(suffix)

Arguments

Return Value character(len=4)

public function my_status_string(key, info) result(val)

Arguments

Return Value character(len=80)

public function my_status_string_vec(key, info) result(val)

Arguments

Return Value character(len=80)(size(key))

public function my_status_int(key, info, def) result(val)

Arguments

Return Value integer

public function my_status_int_vec(key, info, def) result(val)

Arguments

Return Value integer(size(key))

Subroutines

public subroutine init_env()

Arguments

public subroutine init_random_seed(idx)

Arguments

public subroutine fin_env()

Arguments

public subroutine tem_load_env_params(conf)

Arguments

public subroutine print_self_status(unit, info, text)

Arguments

public subroutine tem_connect_toNull(null_unit)

Arguments