pencil.read.ogdims

Contains the classes and methods to read the simulation dimensions.

Classes

ogDim -- holds pencil code dimension data.

ogdim(*args, **kwargs)

ogdim(datadir='data', proc=-1)

pencil.read.ogdims.ogdim(*args, **kwargs)

ogdim(datadir=’data’, proc=-1)

Read the ogdim.dat file.

Parameters:

datadir (string) – Directory where the data is stored.
proc (int) – Processor to be read. If proc is -1, then read the ‘global’ dimensions. If proc is >=0, then read the dim.dat in the corresponding processor directory.

Return type:

Class containing the simulation dimensions.

class pencil.read.ogdims.ogDim

Bases: pencil.read.dims.Dim

ogDim – holds pencil code dimension data.