pencil.diag.tracers

Reads the tracer files, composes a color map.

Classes

Tracers	Tracers -- Holds the traced tracer object with the field line integrated
TracersParameterClass	__TracersParameterClass -- Holds the simulation and tracing parameters.

Module Contents

class pencil.diag.tracers.Tracers

Bases: object

Tracers – Holds the traced tracer object with the field line integrated quantities and the mapping.

Fill members with default values.

params

x0 = None

y0 = None

x1 = None

y1 = None

z1 = None

l = None

tracers = None

mapping = None

t = None

aa = None

ee = None

curly_A = None

splines = None

find_tracers(var_file='VAR0', datadir='data', trace_field='bb', ti=-1, tf=-1)

Trace streamlines of the vectofield ‘field’ from z = z0 to z = z1 and integrate quantities ‘int_q’ along the lines. Creates a 2d mapping as in ‘streamlines.f90’.

call signature:

find_tracers(var_file=’VAR0’, datadir=’data’, trace_field=’bb’,

ti=-1, tf=-1)

Keyword arguments:

var_file:

Varfile to be read.

datadir:

Directory where the data is stored.

trace_field:

Vector field used for the streamline tracing.

ti:

Initial VAR file index for tracer time sequences. Overrides ‘var_file’.

tf:

Final VAR file index for tracer time sequences. Overrides ‘var_file’.

write(datadir='data', destination='tracers.hdf5')

Write the tracers into a file.

call signature:

write(self, datadir=’data’, destination=’tracers.hdf5’)

Keyword arguments:

datadir:

Directory where the data is stored.

destination:

Destination file.

read(datadir='data', file_name='tracers.hdf5')

Read the tracers from a file.

call signature:

read(self, datadir=’data’, file_name=’tracers.hdf5’)

Keyword arguments:

datadir:

Directory where the data is stored.

file_name:

File with the tracer data.

class pencil.diag.tracers.TracersParameterClass

Bases: object

__TracersParameterClass – Holds the simulation and tracing parameters.

Initialize the parameters.

dx = 0

dy = 0

dz = 0

Ox = 0

Oy = 0

Oz = 0

Lx = 0

Ly = 0

Lz = 0

nx = 0

ny = 0

nz = 0

trace_field = ''

rtol = 1e-08

atol = 1e-08

periodic_x = False

periodic_y = False

periodic_z = False

interpolation = 'trilinear'

method = 'RK45'

trace_sub = 1

int_q = ''

var_file = 'VAR0'

ti = -1

tf = -1

datadir = 'data'

destination = 'tracers.hdf5'

n_proc = 1