Massively Parallel Trotter-Suzuki Solver  1.6.1
Public Member Functions | Private Member Functions | List of all members
Lattice2D Class Reference

This class defines the 2D lattice structure over which the state and potential matrices are defined. More...

#include <trottersuzuki.h>

Inheritance diagram for Lattice2D:

Public Member Functions

 Lattice2D (int dim, double length, bool periodic_x_axis=false, bool periodic_y_axis=false, double angular_velocity=0.)
 
 Lattice2D (int dim_x, double length_x, int dim_y, double length_y, bool periodic_x_axis=false, bool periodic_y_axis=false, double angular_velocity=0.)
 

Private Member Functions

void init (int dim_x, double length_x, int dim_y, double length_y, bool periodic_x_axis=false, bool periodic_y_axis=false, double angular_velocity=0.)
 

Detailed Description

This class defines the 2D lattice structure over which the state and potential matrices are defined.

As to single-process execution, the lattice is a single tile which can be surrounded by a halo, in the case of periodic boundary conditions. As to multi-process execution, the lattice is divided in smaller lattices, dubbed tiles, one for each process. Each of the tiles is surrounded by a halo.

Constructor & Destructor Documentation

Lattice2D::Lattice2D ( int  dim,
double  length,
bool  periodic_x_axis = false,
bool  periodic_y_axis = false,
double  angular_velocity = 0. 
)

Lattice constructor.

Parameters
[in]dimLinear dimension of the squared lattice.
[in]lengthPhysical length of the lattice's side
[in]periodic_x_axisBoundary condition along the x axis (false=closed, true=periodic).
[in]periodic_y_axisBoundary condition along the y axis (false=closed, true=periodic).
[in]angular_velocityAngular velocity of the frame of reference.
Lattice2D::Lattice2D ( int  dim_x,
double  length_x,
int  dim_y,
double  length_y,
bool  periodic_x_axis = false,
bool  periodic_y_axis = false,
double  angular_velocity = 0. 
)

Lattice constructor.

Parameters
[in]dim_xLinear dimension in x direction
[in]length_xPhysical length of the lattice's side along the x axis.
[in]dim_yLinear dimension in y direction
[in]length_yPhysical length of the lattice's side along the y axis.
[in]periodic_x_axisBoundary condition along the x axis (false=closed, true=periodic).
[in]periodic_y_axisBoundary condition along the y axis (false=closed, true=periodic).
[in]angular_velocityAngular velocity of the frame of reference.

The documentation for this class was generated from the following files: