dnami

The dnami module and all its functions.

The dnami functions

The dnami module contains functions to setup a simulation run.

src.src_py.dnami.allocate(tree)

Allocates memory based on computational parameters in the tree.

Parameters

tree – The dnami tree data structure

Returns

A dictionary containing all the parameters needed for the simulation.

src.src_py.dnami.create_grid(tree)

Creates the grid as specified by the user.

Parameters

tree – The dnami tree data structure

Returns

A dictionary containing all the parameters needed for the simulation.

src.src_py.dnami.create_tree()

Creates the dnami tree data structure. This data structure contains all the parameters of the simulation.

Returns

A dictionary containing all the parameters needed for the simulation.

src.src_py.dnami.cst(x)

Converts the input to the working precision defined in the genRHs.py

Parameters

x – input to be converted

Returns

Numpy object that has the desired working precision

src.src_py.dnami.start_mpi(tree)

Initializes the MPI class of dnami.

Parameters

tree – The dnami tree data structure

Returns

A dictionary containing all the parameters needed for the simulation.

src.src_py.dnami.unpack_bcs(tree)

Organises the list of boundary conditions based on those specified in the genRhs.py

Parameters

tree – The dnami tree data structure

Returns

A dictionary containing all the parameters needed for the simulation with updated boundary condition information.