espressopp.analysis.LBOutput¶

Overview

`espressopp.analysis.LBOutputScreen`
`espressopp.analysis.LBOutputVzInTime`
`espressopp.analysis.LBOutputVzOfX`

Details

Abstract output class for LB simulations. The implemented realisations are:

espressopp.analysis.LBOutputScreen to output simulation progress and control flux conservation when using MD to LB coupling.
espressopp.analysis.LBOutputVzInTime to output velocity component \(v_z\) on the lattice site with an index \((0.25*N_i, 0, 0)\) in time.
espressopp.analysis.LBOutputVzOfX to output local density \(\rho\) and \(v_z\) component of the velocity as a function of the coordinate \(x\).

Note

all derived output classes have to be called from class espressopp.integrator.ExtAnalyze with specified periodicity of invokation and after this added to the integrator. See examples.

espressopp.analysis.LBOutputScreen¶

Computes and outputs to the screen the simulation progress (finished step) and controls mass flux conservation when using MD-to-LB coupling. Ideally, the sum of mass fluxes should be \(0\), i.e. \(j_{LB} + j_{MD} = 0\).

class espressopp.analysis.LBOutputScreen(system, lb)¶

Parameters:	system (shared_ptr) – system object defined earlier in the python-script lb (lb_object) – lattice boltzmann object defined earlier in the python-script

Example:

>>> # initialise output to the screen 
>>> outputScreen = espressopp.analysis.LBOutputScreen(system,lb)
>>>
>>> # initialise external analysis object with previously created output object 
>>> # and periodicity of invocation (steps):
>>> extAnalysis = espressopp.integrator.ExtAnalyze(outputScreen,100)
>>>
>>> # add the external analysis object as an extension to the integrator
>>> integrator.addExtension( extAnalysis )

espressopp.analysis.LBOutputVzInTime¶

Computes and outputs the velocity component \(v_z\) in time on the lattice site with an index \((0.25*N_i, 0, 0)\).

class espressopp.analysis.LBOutputVzInTime(system, lb)¶

Parameters:	system (shared_ptr) – system object defined earlier in the python-script lb (lb_object) – lattice boltzmann object defined earlier in the python-script

Example:

>>> # initialise output of the Vz as a function of time 
>>> outputVzInTime = espressopp.analysis.LBOutputVzInTime(system,lb)
>>>
>>> # initialise external analysis object with previously created output object
>>> # and periodicity of invocation (steps):
>>> extAnalysis = espressopp.integrator.ExtAnalyze(outputVzInTime,100)
>>>
>>> # add the external analysis object as an extension to the integrator
>>> integrator.addExtension( extAnalysis )

espressopp.analysis.LBOutputVzOfX¶

Computes and outputs simulation progress (finished step) and controls flux conservation when using MD to LB coupling.

class espressopp.analysis.LBOutputVzOfX(system, lb)¶

Parameters:	system (shared_ptr) – system object defined earlier in the python-script lb (lb_object) – lattice boltzmann object defined earlier in the python-script

Example:

>>> # initialise output of the Vz as a function of x-coordinate
>>> outputVzOfX = espressopp.analysis.LBOutputVzOfX(system,lb)
>>>
>>> # initialise external analysis object with previously created output object
>>> # and periodicity of invocation (steps):
>>> extAnalysis = espressopp.integrator.ExtAnalyze(outputVzOfX,100)
>>>
>>> # add the external analysis object as an extension to the integrator
>>> integrator.addExtension( extAnalysis )