pylbm.Simulation¶

class pylbm.Simulation(dico, sorder=None, dtype='float64', check_inverse=False, initialize=True)¶

create a class simulation

Parameters:

dicodictionary

domainobject of class Domain, optional

schemeobject of class Scheme, optional

typeoptional argument (default value is ‘float64’)

Attributes:

dimint

spatial dimension

typefloat64

the type of the values

domainDomain

the domain given in argument

schemeScheme

the scheme given in argument

mnumpy array

get the moment i in the interior domain.

Fnumpy array

get the distribution function i in the interior domain.

m_halonumpy array

get the moment i on the whole domain with halo points.

F_halonumpy array

get the distribution function i on the whole domain with halo points.

Methods

boundary_condition(**kwargs)	perform the boundary conditions
equilibrium([m_user])	set the moments to the equilibrium values (the array _m is modified)
f2m(**kwargs)	compute the moments from the distribution functions (the array _m is modified)
initialization()	initialize all the numy array with the initial conditions set the initial values to the numpy arrays _F and _m
m2f([m_user, f_user])	compute the distribution functions from the moments (the array _F is modified)
one_time_step(**kwargs)	compute one time step
relaxation(**kwargs)	compute the relaxation phase on moments (the array _m is modified)
source_term([fraction_of_time_step])	compute the source term phase on moments (the array _m is modified)
transport(**kwargs)	compute the transport phase on distribution functions (the array _F is modified)

Notes

The methods transport, relaxation, equilibrium, f2m, m2f, boundary_condition, and one_time_step are just call of the methods of the class Scheme.

Examples

see demo/examples/

Attributes

F	get the distribution function i in the interior domain.
F_halo	get the distribution function i on the whole domain with halo points.
dt
m	get the moment i in the interior domain.
m_halo	get the moment i on the whole domain with halo points.