Class : ThreeDConstantCellPotential

class deriving from AbstractPotential

~ThreeDConstantCellPotential :

prototype: virtual ~ThreeDConstantCellPotential ()

description:destructor



GetNumberCellX :

prototype: int GetNumberCellX ()

description:get the number of cells in X direction



GetNumberCellY :

prototype: int GetNumberCellY ()

description:get the number of cells in Y direction



GetNumberCellZ :

prototype: int GetNumberCellZ ()

description:get the number of cells in Y direction



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



SavePotential :

prototype: virtual void SavePotential (char* fileName )

description:save the potential in a file


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



LoadPotential :

prototype: virtual void LoadPotential (char* fileName )

description:load the potential from a file


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



SetPotential :

prototype: virtual void SetPotential (int , 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
k = z coordinate of the considered cell
value = value of potential



GetPotential :

prototype: virtual double GetPotential (int , int , int k )

description:get the potential at a given position


input parameters:
i = x coordinate of the considered cell
j = y coordinate of the considered cell
k = z 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.