This page was generated from appendix-pickling/pickling.ipynb.

Pickling of NGSolve objects

Python objects an be converted to byte-streams, which can be stored to files, and later the Python object can be reconstructed by the inverse process. In general this is known as serialization, in Python it is called pickling, see https://docs.python.org/3/library/pickle.html. Another usecase is parallel computing, where it is used to send whole Python objects across a network.

Many of the NGSolve-objects support pickling.

from ngsolve import *
from ngsolve.webgui import Draw

mesh = Mesh(unit_square.GenerateMesh(maxh=0.3))

import pickle
outfile = open("mesh.pkl", "wb")
pickle.dump(mesh, outfile)

infile = open("mesh.pkl", "rb")
mesh2 = pickle.load(infile)
mesh2.nv, mesh2.ne

(19, 24)

Draw (mesh2);

Shared objects remain shared

When we create several spaces on the same mesh, all spaces link to the mesh via a shared pointer. Similarly, if we have several GridFunctions defined on the same space, they link to it using a shared pointer. These shared objects remain shared after pickling and unpickling:

fes = H1(mesh, order=2)
gfu1 = GridFunction(fes)
gfu2 = GridFunction(fes)
gfu1.Set(x)
gfu2.Set(y)

outfile = open("gridfunction.pkl", "wb")
pickle.dump([gfu1,gfu2], outfile)

infile = open("gridfunction.pkl", "rb")
gfv1,gfv2 = pickle.load(infile)
print ("the same spaces:", id(gfv1.space), "=?=", id(gfv2.space))

Draw (gfv1);

the same spaces: 140347193904880 =?= 140347193904880

Pickling expression trees

CoefficientFunction expression trees support pickling as well.

func = x*gfu1 + y
print (func)

coef binary operation '+', real
  coef binary operation '*', real
    coef coordinate x, real
    coef N6ngcomp14S_GridFunctionIdEE, real
  coef coordinate y, real

outfile = open("func.pkl", "wb")
pickle.dump([mesh,func], outfile)

infile = open("func.pkl", "rb")
mesh2,func2 = pickle.load(infile)

print (func2)

Draw (func2, mesh2);

coef binary operation '+', real
  coef binary operation '*', real
    coef coordinate x, real
    coef N6ngcomp14S_GridFunctionIdEE, real
  coef coordinate y, real

We were pickling the mesh explicitly to have it available for drawing, it would be contained in the function func anyway.

import os
os.remove("mesh.pkl")
os.remove("gridfunction.pkl")
os.remove("func.pkl")

Implementation of pickling

pybind11-pickling supports wrapping of serialization of user-classes.

And then there is ngcore - archive …