Derived Types

Define abstract type to represent the config type, allows common code to be moved here

FIXME : Add documentation

FIXME : Add documentation

Used to represent the input configuration of ballstab

This is the next level up of data and represents the cell type. A cell has a unique it,ik pair and represents all the fields/field eq on the extended domain for the given it/ik

This is the next level up of data and represents the cell type. A cell has a unique it,ik pair and represents all the fields/field eq on the extended domain for the given it/ik

Used to represent the input configuration of collisions

A simple object for storing details of a communicator

A type to record information about connections between iglo points Store the iglo and iproc indices for connections to the left and right of a given point. Initialised to no connections, indicated by negative values

FIXME : Add documentation

Density-velocity perturbations

Holds integers corresponding to the ascii output units

Used to represent the input configuration of gs2_diagnostics. This is the version used by the original diagnostics module.

A type for storing the diagnostics configuration, a reference to the output file, and current results of the simulation

Used to represent the input configuration of dist_fn

Used to represent the input configuration of dist_fn_species. There should be one of this namelist for each species simulated.

Used to represent the input configuration of driver. See the documentation of the antenna module for more details.

FIXME : Add documentation

A custom type to look after the netcdf ids for the eigenvalue file

A type to hold a collection of geometrical quantities as calculated by eikcoefs

Type providing an exit code and message text for exit reasons

FIXME : Add documentation

Information about a planned 42 transform

FIXME : Add documentation

This is the top level object, consisting of a collection of ky blocks.

This is the top level object, consisting of a collection of ky blocks. Currently only support: 0 : Invert the field matrix In the future may wish to do things like LU decomposition etc. Could also do things like eigenvalue analysis etc.

Used to represent the input configuration of fields

Public type allowing tests to access otherwise-private routines

Helper type to wrap up some flux surface specific variables for analytic equilibrium type.

FIXME : Add documentation

A derived type used to hold the inputs to the geo initialisation routine. By encapsulating all possible inputs in this type we can avoid having to have multiple initialisation interfaces which all types have to define.

FIXME : Add documentation

A type for storing outputs of gs2 for access externally

The object which specifies and records the gs2 program state. Some attributes of the object, like mp_comm_external, are designed to be directly manipulated by the user, and some are designed to store program state information and be manipulated internally, like init%level.

Holds data pertaining to some of the main algorithm timers.

FIXME : Add documentation

Used to represent the input configuration of hyper

FIXME : Add documentation

FIXME : Add documentation

FIXME : Add documentation

FIXME : Add documentation

Used to represent the input configuration of ingen

Used to represent the input configuration of init_g

A type for labelling the different init levels available in gs2.

Define an type to represent an initialisation level. This uses a hack to approximate type extension without the boiler plate of extending an abstract type. Specifically, we offer a type bound change_level procedure which just calls a procedure pointer to implement the actual work to change the level, specific to each instance.

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

A type for storing overrides of the intial values of the fields and distribution function. This override is different to all the others, because in order to minimise memory usage and disk writes, this override is used internally during the simulation, and its values can thus change over the course of the simulation. In contrast, no other overrides are modified by running gs2. Also, depending on the value of in_memory, the override values will either be taken from the the arrays within the object, or from the restart files. If you want to externally modify the initial field and dist fn values, you need to use in_memory = .true. If you just want to use this override to allow you to reinitialise the equations and start from the same values, you can use either memory or restart files. If you want to want to change the number of processors and then reinitialise and then use this override you must use in_memory = .false., because currently the memory is allocated on a processor by processor basis. Changing grid sizes and then using this override is not supported. This one is too complicated to generate automatically

FIXME : Add documentation

Used to represent the input configuration of run_parameters through "knobs"

Used to represent the input configuration of kt_grids_box

Used to represent the input configuration of kt_grids

A type for containing overrides to the perpendicular grids (x and y).

Used to represent the input configuration of kt_grids_range

Used to represent the input configuration of kt_grids_single

Used to represent the input configuration of kt_grids_specified

Used to represent the input configuration of a specific specified wavenumber pair

This is the next level up of data and represents the ky type. A ky block consists of a number of supercells

This is the next level up of data and represents the ky type. A ky block consists of a number of supercells

Used to represent the input configuration of layouts

Used to represent the input configuration of le_grids

FIXME : Add documentation

FIXME : Add documentation

A simple wrapper type around an integer to represent different inversion methods. We could consider deriving from this and binding the specific inversion methods to the type, but that is perhaps more complication than required.

A simple wrapper type around an integer to represent different multiply methods.

An object for overriding all or selected Miller geometry parameters.

Mersenne-Twister object. Allows multiple, independent instances to be used within a program

Used to represent the input configuration of nonlinear_terms

Public type allowing tests to access otherwise-private routines

Used to represent the input configuration of normalisations. These values are not used for anything but will be written to the output file to aid post processing etc.

Define a type to hold the set of normalisations, we could imagine extending this in the future to provide a normalise/denormalise routine which can be used to automatically convert quantities

Used to represent the input configuration for GS2's optimisation procedure. When turned on, GS2 performs a scan for the given input file, varying different optimisation flags. Results of this scan are reported in .optim. The optimal parameters are stored, allowing a user to run the same input file with optimised parameters in the same execution. A user can also choose to continue with a less-than-optimal set of parameters which satisfy other constraints.

A type for storing the optimisation configuration, the results

A type for containing overrides to the processor layout and optimisation flags for gs2.

FIXME : Add documentation

Used to represent the input configuration of parameter_scan

This is the type which controls/organises the parallel data decomposition etc.

This is the type which controls/organises the parallel data decomposition etc. the local fields. This may impact diagnostics/parallel writing as it means only the processors gf_lo local section of the fields are evolved on this processor.

Holds data representing a periodic spline. Should be set up by calling new_periodic_spline.

FIXME : Add documentation

An object for overriding all or selected profile parameters, for example species temps, densities or gradients or the flow gradient or mach number. Note that all species parameters are arrays of size nspec and you must set the override switches individually for each species.

Small container type simply providing a 1D allocatable buffer. Used to allow array of buffers of different sizes.

FIXME : Add documentation

Used to represent the input configuration of reinit

A type for storing the current results of the simulation

Internal named type to represent scheme ids

Public type storing the data for a particular RK scheme

This is the lowest level of data object and will hold the actual data involved with the field matrix

This is the lowest level of data object and will hold the actual data involved with the field matrix

Type providing information about the code version, compiler, build environment etc

FIXME : Add documentation

FIXME : Add documentation

Used to represent the input configuration of source

FIXME : Add documentation

Used to represent the input configuration of species

Used to represent the input configuration of species

Holds data representing a non-periodic spline. Should be set up by calling new_spline.

Used to represent the input configuration of split_nonlinear_terms

A header for files and output.

Used to represent the input configuration of stir. See the documentation of the antenna module for more details.

This is the next level up of data and represents the supercell type. A supercell represents a collection of connected cells

This is the next level up of data and represents the supercell type. A supercell represents a collection of connected cells

FIXME : Add documentation

Used to represent the input configuration of theta_grid

Used to represent the input configuration of theta_grid

Used to represent the input configuration of theta_grid

Used to represent the input configuration of theta_grid_gridgen

Used to represent the input configuration of theta_grid. Sets a number of parameters used by the different theta grid implementations. Not all parameters are active for a given theta grid type.

Used to represent the input configuration of theta_grid_salpha

A type for containing overrides to the timestep and the cfl parameters

FIXME : Add documentation

FIXME : Add documentation