Octopus
controlfunction_oct_m::controlfunction_common_t Type Reference

This data type contains information that is filled when the module is initialized ("controlfunction_mod_init"), and stored while the module is in use (until "controlfunction_mod_close" is called). It is information more or less common to all control functions. More...

Detailed Description

This data type contains information that is filled when the module is initialized ("controlfunction_mod_init"), and stored while the module is in use (until "controlfunction_mod_close" is called). It is information more or less common to all control functions.

Definition at line 199 of file controlfunction.F90.

Private Attributes

integer representation = 0
 The "representation" may be any one of the {ctr_internal, ctr_rt, ctr_fourier_series_h, ctr_zero_fourier_series_h, ctr_fourier_series, ctr_zero_fourier_series} set. If it is zero, then it is not initialized. This is set by the OCTControlFunctionRepresentation. More...
 
real(real64) omegamax = M_ZERO
 The representations based on Fourier expansions (all the "parametrized" ones) contain Fourier expansion coefficients corresponding to frequencies up to this cut-off frequency. More...
 
real(real64) targetfluence = M_ZERO
 This is the fluence that should be conserved when doing optimization in fixed fluence mode. It is determined by the input variable OCTFixFluenceTo. More...
 
logical fix_initial_fluence = .false.
 This determines whether or not to scale the initial guess field to have the fixed fluence given by targetfluence. More...
 
integer mode = controlfunction_mode_none
 This may be one of {controlfunction_mode_epsilon, controlfunction_mode_f, controlfunction_mode_phi}, and is set by the OCTControlFunctionType input variable. It determines whether the full time-dependent function is to be controlled, or only the "envelope" or "phase" components. More...
 
real(real64) w0 = M_ZERO
 The carrier frequency, in case the mode is set to control the "envelope" or the "phase". More...
 
integer no_controlfunctions = 0
 
real(real64), dimension(:), allocatable alpha
 A factor that determines the "penalty", for each of the control functions. More...
 
type(tdf_t), dimension(:), allocatable td_penalty
 The penalties, if these are time-dependent. More...
 

Member Data Documentation

◆ representation

integer controlfunction_oct_m::controlfunction_common_t::representation = 0
private

The "representation" may be any one of the {ctr_internal, ctr_rt, ctr_fourier_series_h, ctr_zero_fourier_series_h, ctr_fourier_series, ctr_zero_fourier_series} set. If it is zero, then it is not initialized. This is set by the OCTControlFunctionRepresentation.

Definition at line 201 of file controlfunction.F90.

◆ omegamax

real(real64) controlfunction_oct_m::controlfunction_common_t::omegamax = M_ZERO
private

The representations based on Fourier expansions (all the "parametrized" ones) contain Fourier expansion coefficients corresponding to frequencies up to this cut-off frequency.

Definition at line 206 of file controlfunction.F90.

◆ targetfluence

real(real64) controlfunction_oct_m::controlfunction_common_t::targetfluence = M_ZERO
private

This is the fluence that should be conserved when doing optimization in fixed fluence mode. It is determined by the input variable OCTFixFluenceTo.

Definition at line 209 of file controlfunction.F90.

◆ fix_initial_fluence

logical controlfunction_oct_m::controlfunction_common_t::fix_initial_fluence = .false.
private

This determines whether or not to scale the initial guess field to have the fixed fluence given by targetfluence.

Definition at line 212 of file controlfunction.F90.

◆ mode

integer controlfunction_oct_m::controlfunction_common_t::mode = controlfunction_mode_none
private

This may be one of {controlfunction_mode_epsilon, controlfunction_mode_f, controlfunction_mode_phi}, and is set by the OCTControlFunctionType input variable. It determines whether the full time-dependent function is to be controlled, or only the "envelope" or "phase" components.

Definition at line 214 of file controlfunction.F90.

◆ w0

real(real64) controlfunction_oct_m::controlfunction_common_t::w0 = M_ZERO
private

The carrier frequency, in case the mode is set to control the "envelope" or the "phase".

Definition at line 219 of file controlfunction.F90.

◆ no_controlfunctions

integer controlfunction_oct_m::controlfunction_common_t::no_controlfunctions = 0
private

Definition at line 221 of file controlfunction.F90.

◆ alpha

real(real64), dimension(:), allocatable controlfunction_oct_m::controlfunction_common_t::alpha
private

A factor that determines the "penalty", for each of the control functions.

Definition at line 222 of file controlfunction.F90.

◆ td_penalty

type(tdf_t), dimension(:), allocatable controlfunction_oct_m::controlfunction_common_t::td_penalty
private

The penalties, if these are time-dependent.

Definition at line 224 of file controlfunction.F90.


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