This module handles all history file routines. More...

Data Types
interface	history_filename_set
	Sets/changes the filename for a history file. More...

Functions/Subroutines
subroutine	history_close (HISTORY, ERR, ERROR,)
	Closes a history file. More...

subroutine, public	history_create_finish (HISTORY, ERR, ERROR,)
	Finishes the process of creating a history file. More...

subroutine, public	history_create_start (CONTROL_LOOP, HISTORY, ERR, ERROR,)
	Starts the process of creating a history file. More...

subroutine, public	history_destroy (HISTORY, ERR, ERROR,)
	Destroys a history file. More...

subroutine	history_finalise (HISTORY, ERR, ERROR,)
	Finalises a history file and deallocates all memory. More...

subroutine	history_initialise (CONTROL_LOOP, ERR, ERROR,)
	Initialises a history file. More...

subroutine, public	history_file_format_set (HISTORY, FILE_FORMAT, ERR, ERROR,)
	Sets/changes the file type for a history file. More...

subroutine	history_filename_set_c (HISTORY, FILENAME, ERR, ERROR,)
	Sets/changes the character string filename for a history file. More...

subroutine	history_filename_set_vs (HISTORY, FILENAME, ERR, ERROR,)
	Sets/changes the varying string filename for a history file. More...

subroutine	history_open (HISTORY, ERR, ERROR,)
	Opens a history file. More...

Variables
integer(intg), parameter	history_ascii_file_format =1
	ASCII history file format. More...

integer(intg), parameter	history_binary_file_format =2

Detailed Description

This module handles all history file routines.

Function/Subroutine Documentation

subroutine history_routines::history_close	(	type(history_type), pointer	HISTORY,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Closes a history file.

Parameters

	history	A pointer to the history file to close
[out]	err	The error code
[out]	error	The error string

Definition at line 93 of file history_routines.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by history_finalise().

subroutine, public history_routines::history_create_finish	(	type(history_type), pointer	HISTORY,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Finishes the process of creating a history file.

Parameters

	history	On exit, a pointer to the created history file.
[out]	err	The error code
[out]	error	The error string

Definition at line 120 of file history_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine, public history_routines::history_create_start	(	type(control_loop_type), pointer	CONTROL_LOOP,
		type(history_type), pointer	HISTORY,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Starts the process of creating a history file.

Parameters

	control_loop	A pointer to the control loop to setup
	history	On exit, a pointer to the created history file. Must not be associated on entry.
[out]	err	The error code
[out]	error	The error string

Definition at line 147 of file history_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine, public history_routines::history_destroy	(	type(history_type), pointer	HISTORY,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Destroys a history file.

Parameters

	history	A pointer to the history file to destroy
[out]	err	The error code
[out]	error	The error string

Definition at line 178 of file history_routines.f90.

References base_routines::enters(), base_routines::exits(), and history_finalise().

subroutine, public history_routines::history_file_format_set	(	type(history_type), pointer	HISTORY,
		integer(intg), intent(in)	FILE_FORMAT,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Sets/changes the file type for a history file.

Parameters

	history	A pointer to history to set the file format for
[in]	file_format	The file format to set

See also: HISTORY_ROUTINES::FileFormatTypes,HISTORY_ROUTINES

Parameters

[out]	err	The error code
[out]	error	The error string

Definition at line 268 of file history_routines.f90.

References base_routines::enters(), base_routines::exits(), history_ascii_file_format, and history_binary_file_format.

subroutine history_routines::history_filename_set_c	(	type(history_type), pointer	HISTORY,
		character(len=*), intent(in)	FILENAME,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets/changes the character string filename for a history file.

Parameters

	history	A pointer to history to set the filename for
[in]	filename	The filename to set
[out]	err	The error code
[out]	error	The error string

Definition at line 309 of file history_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine history_routines::history_filename_set_vs	(	type(history_type), pointer	HISTORY,
		type(varying_string), intent(in)	FILENAME,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Sets/changes the varying string filename for a history file.

Parameters

	history	A pointer to history to set the filename for
[in]	filename	The filename to set
[out]	err	The error code
[out]	error	The error string

Definition at line 342 of file history_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine history_routines::history_finalise	(	type(history_type), pointer	HISTORY,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Finalises a history file and deallocates all memory.

Parameters

	history	A pointer to the history file to finalise
[out]	err	The error code
[out]	error	The error string

Definition at line 205 of file history_routines.f90.

References base_routines::enters(), base_routines::exits(), and history_close().

Referenced by history_destroy().

subroutine history_routines::history_initialise	(	type(control_loop_type), pointer	CONTROL_LOOP,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Initialises a history file.

Parameters

	control_loop	A pointer to the control_loop to initialise the history file for
[out]	err	The error code
[out]	error	The error string

Definition at line 231 of file history_routines.f90.

References base_routines::enters(), base_routines::exits(), and history_binary_file_format.

subroutine history_routines::history_open	(	type(history_type), pointer	HISTORY,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

private

Opens a history file.

Parameters

	history	A pointer to the history file to open
[out]	err	The error code
[out]	error	The error string

Definition at line 375 of file history_routines.f90.

References base_routines::enters(), and base_routines::exits().

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation