pylag.particle_initialisation module

Particle state initialisation

This module provides the following functionality:

1. Reading of particle initialisation files

2. Reading of model restart files

class pylag.particle_initialisation.ASCIIInitialParticleStateReader(config)

Bases: InitialParticleStateReader

ASCII initial particle state reader

ASCIIInitialParticleStateReaders read in particle state data from an ascii file and return it to the caller.

Parameters

config (configparser.ConfigParser) – Configuration object

Todo

• At the moment, such objects only read in particle position info.

It may be desirable to have them read other types of data in the future.

get_particle_data()

Get particle data

Particle data is read in from an ASCII file.

class pylag.particle_initialisation.InitialParticleStateReader

Bases: object

Initial particle state reader

Abstract base class for initial particle state readers. Such objects are are used to read or calculate initial particle state data such as initial positions or in different contexts. These are then returned to the caller in the form of lists. The caller must manage the actual setting of particle properties for each Particle object it manages - this is not done here.

get_particle_data()

class pylag.particle_initialisation.RestartInitialParticleStateReader(config)

Bases: InitialParticleStateReader

Restart initial particle state reader

RestartInitialParticleStateReaders read in particle state data from a restart file in NetCDF format.

Parameters

config (configparser.ConfigParser) – Configuration object

get_particle_data()

Get particle data

Particle data is read in from a NetCDF file that has been created using an object of type RestartFileCreator.

pylag.particle_initialisation.get_initial_particle_state_reader(config)

Factor method for particle initial state readers

Parameters

config (configparser.ConfigParser) – Configuraiton object

Returns

Particle initial state reader

Return type

plag.particle_initialisation.InitialParticleStateReader