init_type Derived Type

type, public :: init_type

A type for storing the current initialization status, as well as all the overrides.


Contents

Source Code


Components

Type Visibility Attributes Name Initial
integer, public :: level = 0

The current init level

logical, public :: diagnostics_initialized = .false.

Whether or not diagnostics have been initialized Not obvious why this belongs here really as we don't deal with diagnostics in this module.

type(miller_geometry_overrides_type), public :: mgeo_ov

An object for overriding all or selected Miller geometry parameters. You must call gs2_main::prepare_miller_geometry_overrides before setting these overrides. See documentation for the overrides::miller_geometry_overrides_type for more information.

type(kt_grids_overrides_type), public :: kt_ov

An object for overriding all or selected profile parameters such as species temperature, density, and gradients as well as the flow gradient and mach number. You must call gs2_main::prepare_profiles_overrides before setting these overrides. See documentation for the overrides::profiles_overrides_type for more information.

type(profiles_overrides_type), public :: prof_ov

An object for overriding all or selected kt_grids parameters such as ny, nx, y0, jtwist etc. You must call gs2_main::prepare_kt_grids_overrides before setting these overrides. See documentation for the overrides::kt_grids_overrides_type for more information.

type(timestep_overrides_type), public :: tstep_ov

An object for overriding parameters connected to the timestep and cfl condition

type(initial_values_overrides_type), public :: initval_ov

An object for overriding the initial values of the fields and distribution function. You must call gs2_main::prepare_initial_values_overrides before setting these overrides. This override is very complicated. See documentation for the overrides::initial_values_overrides_type for more information.

type(optimisations_overrides_type), public :: opt_ov

An object for overriding non physics parameters which may alter run time and efficiency. You must call gs2_main::prepare_optimisations_overrides before setting these overrides.


Source Code

  type init_type
     !> The current init level
     integer :: level = 0
     !> Whether or not diagnostics have been initialized
     !> Not obvious why this belongs here really as we don't
     !> deal with diagnostics in this module.
     logical :: diagnostics_initialized = .false.
     !> An object for overriding all or selected
     !> Miller geometry parameters. You must call
     !> gs2_main::prepare_miller_geometry_overrides
     !> before setting these overrides. See
     !> documentation for the overrides::miller_geometry_overrides_type
     !> for more information.
     type(miller_geometry_overrides_type) :: mgeo_ov
     !> An object for overriding all or selected
     !> profile parameters such as species temperature, density, and gradients
     !> as well as the flow gradient and mach number. You must call
     !> gs2_main::prepare_profiles_overrides
     !> before setting these overrides. See
     !> documentation for the overrides::profiles_overrides_type
     !> for more information.
     type(kt_grids_overrides_type) :: kt_ov
     !> An object for overriding all or selected
     !> kt_grids parameters such as ny, nx, y0, jtwist etc.
     !> You must call
     !> gs2_main::prepare_kt_grids_overrides
     !> before setting these overrides. See
     !> documentation for the overrides::kt_grids_overrides_type
     !> for more information.
     type(profiles_overrides_type) :: prof_ov
     !> An object for overriding parameters connected
     !> to the timestep and cfl condition
     type(timestep_overrides_type) :: tstep_ov
     !> An object for overriding the initial values of
     !> the fields and distribution function. You must call
     !> gs2_main::prepare_initial_values_overrides
     !> before setting these overrides. This override
     !> is very complicated. See
     !> documentation for the overrides::initial_values_overrides_type
     !> for more information.
     type(initial_values_overrides_type) :: initval_ov
     !> An object for overriding non physics parameters which
     !> may alter run time and efficiency. You must call
     !> gs2_main::prepare_optimisations_overrides
     !> before setting these overrides.
     type(optimisations_overrides_type) :: opt_ov
  end type init_type