Pythonic Virtual Machine
ExtractPotential Class Reference

Detailed Description

This circuit will extract the potential from a cubic LOCPOT file, as well as outputting to the terminal information regarding the locpot eg: Stepsize etc.

Initialisation parameters:

  • PotentialFilename = LOCPOT Filename | string
  • OutputFilename = Output Filename | string
  • ZCutOff = [LowerIndex | int ,UpperIndex | int] This is the upper and lower z index cut offs allowings users to cut off top or bottom of locpot files

Input channels: None

Output channels: None

Examples:

1 machine.AddCircuit(type='ExtractPotential',name='host.LOCPOT', OutputFilename="File.dat",PotentialFilename=InputFilename,ZCutOff=[200,20])

Inherits Circuit.

Additional Inherited Members

- Public Attributes inherited from Circuit
 name
 Name of the circuit. More...
 
 enabled
 if it is working... More...
 
 machine
 Reference to the virtual machine to which this circuit belongs. More...
 
 pushed
 Push output buffer at the end of Update. More...
 
 I
 Dictionary of input channels.
 
 O
 Dictionary of output channels.
 
 cCoreID
 index of circuit in cCore
 

Documentation for pyVAFM
Generated on Wed Feb 8 2017 10:13:49 for pyVAFM by doxygen 1.8.9.1