Class : BinaryTwoDConstantCellPotential

class deriving from TwoDConstantCellPotential

BinaryTwoDConstantCellPotential :

prototype: BinaryTwoDConstantCellPotential (int , int numberY )

description:constructor


input parameters:
numberX, numberY = number of cells in X and Y directions respectively



~BinaryTwoDConstantCellPotential :

prototype: virtual ~BinaryTwoDConstantCellPotential ()

description:destructor



ConstructEffectivePotential :

prototype: void ConstructEffectivePotential (ThreeDConstantCellPotential* , RealVector& coefficient )

description:construct a potential by averaging a 3D potential in the Z direction


input parameters:
potential = 3D potential with constant value in each cell
coefficient = the coefficient for each monolayer



ShiftPotential :

prototype: virtual void ShiftPotential (double delta )

description:shift the potential with a given quantity


input parameters:
delta = shift value



SaveDiagram :

prototype: virtual void SaveDiagram (char* fileName )

description:save the diagram of atoms in a file


input parameters:
fileName = name of the file to stock the diagram



LoadDiagram :

prototype: virtual void LoadDiagram (char* fileName )

description:load the diagram of atoms from a file


input parameters:
fileName = name of the file in which the diagram is stocked



SetPotential :

prototype: virtual void SetPotential (int , int , double& value )

description:assign the potential a value at a given position


input parameters:
i = x coordinate of the considered cell
j = y coordinate of the considered cell
value = value of potential



GetPotential :

prototype: virtual double GetPotential (int , int j )

description:get the potential at a given position


input parameters:
i = x coordinate of the considered cell
j = y coordinate of the considered cell


return value: the potential in the cell



SaveBmpPicture :

prototype: virtual void SaveBmpPicture (char* fileName )

description:save the whole diagram presentation in a bitmap file


input parameters:
fileName = name of the file to stock the diagram presentation



Back to index.