Ising_OPV::Lattice::Lattice_Params Struct Reference

This struct contains all of the main input parameters needed by the Lattice class. More...

#include <Lattice.h>

Public Attributes
bool	Enable_periodic_x = false
	Determines whether the x-direction periodic boundaries will be enabled. More...
bool	Enable_periodic_y = false
	Determines whether the y-direction periodic boundaries will be enabled. More...
bool	Enable_periodic_z = false
	Determines whether the z-direction periodic boundaries will be enabled. More...
int	Length = 0
	Defines the desired x-direction size of the lattice. More...
int	Width = 0
	Defines the desired y-direction size of the lattice. More...
int	Height = 0
	Defines the desired z-direction size of the lattice. More...
double	Unit_size = 0.0
	Defines the desired lattice unit size, which is used to convert lattice units into real space units. More...

Detailed Description

This struct contains all of the main input parameters needed by the Lattice class.

Copyright

MIT License. For more information, see the LICENSE file that accompanies this software package.

Author

Michael C. Heiber

Date

2014-2019

Member Data Documentation

Enable_periodic_x

bool Ising_OPV::Lattice::Lattice_Params::Enable_periodic_x = false

Determines whether the x-direction periodic boundaries will be enabled.

Enable_periodic_y

bool Ising_OPV::Lattice::Lattice_Params::Enable_periodic_y = false

Determines whether the y-direction periodic boundaries will be enabled.

Enable_periodic_z

bool Ising_OPV::Lattice::Lattice_Params::Enable_periodic_z = false

Determines whether the z-direction periodic boundaries will be enabled.

Height

int Ising_OPV::Lattice::Lattice_Params::Height = 0

Defines the desired z-direction size of the lattice.

Length

int Ising_OPV::Lattice::Lattice_Params::Length = 0

Defines the desired x-direction size of the lattice.

Unit_size

double Ising_OPV::Lattice::Lattice_Params::Unit_size = 0.0

Defines the desired lattice unit size, which is used to convert lattice units into real space units.

Width

int Ising_OPV::Lattice::Lattice_Params::Width = 0

Defines the desired y-direction size of the lattice.

---

The documentation for this struct was generated from the following file:

• Lattice.h