pencil.read.dims

Contains the classes and methods to read the simulation dimensions.

Classes

Dim	Dim -- holds pencil code dimension data.

Functions

dim(*args, **kwargs)

Wrapper for Dim.read()

Module Contents

class pencil.read.dims.Dim

Bases: object

Dim – holds pencil code dimension data.

Fill members with default values.

mvar = 0

maux = 0

mglobal = 0

precision = 'S'

iprocz_slowest = 0

mw = 0

keys()

read(datadir='data', proc=-1, ogrid=False, down=False, param=None)

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

Read the dim.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.

• down (bool) – whether to read dim_down.dat

Return type:

Class containing the domain dimension information.

pencil.read.dims.dim(*args, **kwargs)

Wrapper for Dim.read()