utils Module Reference

Utilities. More...

Data Types
interface	neko_error

Functions/Subroutines
pure integer function, public	filename_suffix_pos (fname)
	Find position (in the string) of a filename's suffix.
pure integer function, public	filename_tslash_pos (fname)
	Find position (in the string) of a filename's trailing slash.
subroutine, public	filename_path (fname, path)
	Extract the path to a file.
subroutine, public	filename_name (fname, name)
	Extract the base name of a file (without path and suffix)
subroutine, public	filename_suffix (fname, suffix)
	Extract a filename's suffix.
subroutine	filename_split (fname, path, name, suffix)
	Extract file name components.
subroutine, public	filename_chsuffix (fname, new_fname, new_suffix)
	Change a filename's suffix.
integer function, public	extract_fld_file_index (fld_filename, default_index)
	Extracts the index of a field file. For example, "myfield.f00045" will return 45. If the suffix of the file name is invalid, returns a default index value.
character(len=100) function, dimension(:), allocatable, public	split_string (string, delimiter)
	Split a string based on delimiter (tokenizer) OBS: very hacky, this should really be improved, it is rather embarrasing code.
pure integer function, public	linear_index (i, j, k, l, lx, ly, lz)
	Compute the address of a (i,j,k,l) array with sizes (1:lx, 1:ly, 1:lz, :)
pure integer function, dimension(4), public	nonlinear_index (linear_index, lx, ly, lz)
	Compute (i,j,k,l) array given linear index with sizes (1:lx, 1:ly, 1:lz, :)
pure logical function, public	index_is_on_facet (i, j, k, lx, ly, lz, facet)
subroutine	neko_error_plain (error_code)
	Reports an error and stops execution.
subroutine	neko_error_msg (error_msg)
	Reports an error and stops execution.
subroutine, public	neko_type_error (base_type, wrong_type, known_types)
	Reports an error allocating a type for a particular base pointer class.
subroutine, public	neko_type_registration_error (base_type, wrong_type, known)
subroutine, public	neko_warning (warning_msg)
	Reports a warning to standard output.
character(:) function, allocatable, public	concat_string_array (array, sep, prepend)
	Concatenate an array of strings into one string with array items separated by spaces.

Variables
integer, parameter, public	neko_fname_len = 1024

Detailed Description

Various utility functions

Function/Subroutine Documentation

concat_string_array()

character(:) function, allocatable, public utils::concat_string_array	(	character(len=*), dimension(:), intent(in)	array,
		character(len=*), intent(in)	sep,
		logical, intent(in)	prepend
	)

Parameters

array	The array of strings.
sep	The separator put between the strings in the array.
prepend	Whether to also prepend the string with the separator.

Definition at line 355 of file utils.f90.

extract_fld_file_index()

integer function, public utils::extract_fld_file_index	(	character(len=*), intent(in)	fld_filename,
		integer, intent(in)	default_index
	)

Parameters

fld_filename	Name of the fld file, e.g. myfield0.f00035.
default_index	The index to return in case the suffix of fld_filename is invalid.

Definition at line 156 of file utils.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

filename_chsuffix()

subroutine, public utils::filename_chsuffix	(	character(len=*)	fname,
		character(len=*)	new_fname,
		character(len=*)	new_suffix
	)

Definition at line 139 of file utils.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

filename_name()

subroutine, public utils::filename_name	(	character(len=*), intent(in)	fname,
		character(len=*), intent(out)	name
	)

Definition at line 86 of file utils.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

filename_path()

subroutine, public utils::filename_path	(	character(len=*), intent(in)	fname,
		character(len=*), intent(out)	path
	)

Definition at line 71 of file utils.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

filename_split()

subroutine utils::filename_split ( character(len=*), intent(in)  fname, character(len=*), intent(out)  path, character(len=*), intent(out)  name, character(len=*), intent(out)  suffix  )

private

Definition at line 114 of file utils.f90.

Here is the call graph for this function:

filename_suffix()

subroutine, public utils::filename_suffix	(	character(len=*)	fname,
		character(len=*)	suffix
	)

Definition at line 107 of file utils.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

filename_suffix_pos()

pure integer function, public utils::filename_suffix_pos

(

character(len=*), intent(in)

fname

)

Definition at line 57 of file utils.f90.

Here is the caller graph for this function:

filename_tslash_pos()

pure integer function, public utils::filename_tslash_pos

(

character(len=*), intent(in)

fname

)

Definition at line 64 of file utils.f90.

Here is the caller graph for this function:

index_is_on_facet()

pure logical function, public utils::index_is_on_facet	(	integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	lx,
		integer, intent(in)	ly,
		integer, intent(in)	lz,
		integer, intent(in)	facet
	)

Definition at line 261 of file utils.f90.

linear_index()

pure integer function, public utils::linear_index	(	integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	l,
		integer, intent(in)	lx,
		integer, intent(in)	ly,
		integer, intent(in)	lz
	)

Definition at line 236 of file utils.f90.

Here is the caller graph for this function:

neko_error_msg()

subroutine utils::neko_error_msg ( character(len=*)  error_msg )

private

Parameters

error_msg

The error message to report.

Definition at line 300 of file utils.f90.

neko_error_plain()

subroutine utils::neko_error_plain ( integer, optional  error_code )

private

Parameters

[optional]

error_code The error code to report.

Definition at line 285 of file utils.f90.

neko_type_error()

subroutine, public utils::neko_type_error	(	character(len=*), intent(in)	base_type,
		character(len=*), intent(in)	wrong_type,
		character(len=*), dimension(:), intent(in)	known_types
	)

Should be used in factories.

Parameters

base_type	The base type of the object, which the factory tried to construct.
wrong_type	The type that was attempted to construct.
known_types	A list of the types that are known.

Definition at line 312 of file utils.f90.

neko_type_registration_error()

subroutine, public utils::neko_type_registration_error	(	character(len=*), intent(in)	base_type,
		character(len=*), intent(in)	wrong_type,
		logical, intent(in)	known
	)

Definition at line 327 of file utils.f90.

neko_warning()

subroutine, public utils::neko_warning

(

character(len=*)

warning_msg

)

Definition at line 345 of file utils.f90.

Here is the caller graph for this function:

nonlinear_index()

pure integer function, dimension(4), public utils::nonlinear_index	(	integer, intent(in)	linear_index,
		integer, intent(in)	lx,
		integer, intent(in)	ly,
		integer, intent(in)	lz
	)

Definition at line 245 of file utils.f90.

Here is the call graph for this function:

split_string()

character(len=100) function, dimension(:), allocatable, public utils::split_string	(	character(len=*)	string,
		character(len=*)	delimiter
	)

Definition at line 198 of file utils.f90.

Variable Documentation

neko_fname_len

integer, parameter, public utils::neko_fname_len = 1024

Definition at line 40 of file utils.f90.