options_utils Module Reference

Routines for handling TPLS configuration options. More...

Public Member Functions
subroutine	has_option (name, has_opt, ierr)
	Was an option with a given name provided? More...
subroutine	get_bool_option (name, value, has_opt, ierr)
	Gets a boolean option of a given name. More...
subroutine	get_integer_option (name, value, has_opt, ierr)
	Gets an integer option of a given name. More...
subroutine	get_double_option (name, value, has_opt, ierr)
	Gets a double option of a given name. More...
subroutine	get_string_option (name, value, has_opt, ierr)
	Gets a string option of a given name. More...

Detailed Description

Routines for handling TPLS configuration options.

Extract configuration from any configuration options files and/or command-line arguments. These routines are wrappers for PETSc's option-handling routines.

Author

Mike Jackson.

Version

Revision:

137

Copyright

(c) 2014, The University of Edinburgh, all rights reserved. This program is distributed under the BSD License See LICENSE.txt for details.

Member Function/Subroutine Documentation

subroutine options_utils::get_bool_option	(	character(len=*), intent(in)	name,
		logical, intent(out)	value,
		logical, intent(out)	has_opt,
		integer, intent(out)	ierr
	)

Gets a boolean option of a given name.

Parameters

[in]	name	Option name.
[out]	has_opt	Was option provided?
[out]	ierr	Error code. 0 if no errors.
[out]	value	Option value.

subroutine options_utils::get_double_option	(	character(len=*), intent(in)	name,
		double precision, intent(out)	value,
		logical, intent(out)	has_opt,
		integer, intent(out)	ierr
	)

Gets a double option of a given name.

Parameters

[in]	name	Option name.
[out]	has_opt	Was option provided?
[out]	ierr	Error code. 0 if no errors.
[out]	value	Option value.

Here is the caller graph for this function:

subroutine options_utils::get_integer_option	(	character(len=*), intent(in)	name,
		integer, intent(out)	value,
		logical, intent(out)	has_opt,
		integer, intent(out)	ierr
	)

Gets an integer option of a given name.

Parameters

[in]	name	Option name.
[out]	has_opt	Was option provided?
[out]	ierr	Error code. 0 if no errors.
[out]	value	Option value.

Here is the caller graph for this function:

subroutine options_utils::get_string_option	(	character(len=*), intent(in)	name,
		character(len=60), intent(out)	value,
		logical, intent(out)	has_opt,
		integer, intent(out)	ierr
	)

Gets a string option of a given name.

Parameters

[in]	name	Option name.
[out]	has_opt	Was option provided?
[out]	ierr	Error code. 0 if no errors.
[out]	value	Option value.

subroutine options_utils::has_option	(	character(len=*), intent(in)	name,
		logical, intent(out)	has_opt,
		integer, intent(out)	ierr
	)

Was an option with a given name provided?

Parameters

[in]	name	Option name.
[out]	has_opt	Was option provided?
[out]	ierr	Error code. 0 if no errors.

---

The documentation for this module was generated from the following file:

• options_utils.F90