opt_control_global_oct_m Module Reference

This module contains the definition of the oct_t data type, which contains some of the basic information about how the OCT run will be done. More...

Detailed Description

This module contains the definition of the oct_t data type, which contains some of the basic information about how the OCT run will be done.

The "oct" variable (whose datatype is oct_t) is declared in the main OCT module, opt_control_oct_m (as a module variable). It is initialized by calling oct_read_inp, defined below in this module.

Data Types
type	oct_t
	!brief The oct_t datatype stores the basic information about how the OCT run is done. More...

Functions/Subroutines
subroutine, public	oct_read_inp (oct, namespace)
	Reads, from the inp file, some global information about how the QOCT run should be. More...
logical pure function, public	oct_algorithm_is_direct (oct)
	Returns .true. if the algorithm to be used is one of the "direct" or "gradient-less" algorithms – the ones that do not require backwards propagations. Returns .false. otherwise. More...

Function/Subroutine Documentation

oct_read_inp()

subroutine, public opt_control_global_oct_m::oct_read_inp	(	type(oct_t), intent(inout)	oct,
		type(namespace_t), intent(in)	namespace
	)

Reads, from the inp file, some global information about how the QOCT run should be.

It uses this information to fill the "oct" variable. All the components of oct are filled, except for mode_fixed_fluence, which is filled when the control parameters module is initialized.

Definition at line 171 of file opt_control_global.F90.

oct_algorithm_is_direct()

logical pure function, public opt_control_global_oct_m::oct_algorithm_is_direct

(

type(oct_t), intent(in)

oct

)

Returns .true. if the algorithm to be used is one of the "direct" or "gradient-less" algorithms – the ones that do not require backwards propagations. Returns .false. otherwise.

Definition at line 406 of file opt_control_global.F90.