pencil.read.phiaverages

Contains the classes and methods to read phi-averaged files.

Classes

Averages

Averages -- holds Pencil Code averages data and methods.

Functions

phiaver(*args, **kwargs)

Wrapper for Averages.read()

Module Contents

class pencil.read.phiaverages.Averages

Bases: object

Averages – holds Pencil Code averages data and methods.

Fill members with default values.

t

keys()

read(datadir='data', avg_file=None, var_index=-1, iter_list=None, precision='f', param=None)

read(datadir=”data”, avg_file=”1”, var_index=-1, iter_list=None, precision=”f”, param=None)

Read Pencil Code phi-averaged data.

Keyword arguments:

datadirstring

Directory where the data is stored.

avg_fileint

Number of average file to be read.

var_indexint

Index of single variable taken from among the ‘phi’ averages. Takes an integer value < len(phiaver.in).

iter_listlist of int

Iteration indices for which to sample the slices.

precisionstring

Float (f), double (d) or half (half).

paramParam object

Param object belonging to the simulation.

pencil.read.phiaverages.phiaver(*args, **kwargs)

Wrapper for Averages.read()