GPUE  v1.0
GPU Gross-Pitaevskii Equation numerical solver for Bose-Einstein condensates
Vtx::Vortex Class Reference

#include <vort.h>

Public Member Functions

 Vortex ()
 
 Vortex (int2 coords, double2 coordsD, int winding, bool isOn, std::size_t timeStep)
 
 ~Vortex ()
 
void updateUID (int uid)
 
void updateWinding (int winding)
 
void updateIsOn (bool isOn)
 
void updateCoords (int2 coords)
 
void updateCoordsD (double2 coordsD)
 
void updateTimeStep (std::size_t timeStep)
 
int getUID () const
 
int getWinding () const
 
bool getIsOn () const
 
int2 getCoords () const
 
double2 getCoordsD () const
 
std::size_t getTimeStep () const
 

Protected Attributes

int uid
 

Friends

class VtxList
 

Detailed Description

Maintains vortex index in grid and least-squares calculated values with winding/direction of vortex rotation.

Definition at line 39 of file vort.h.

Constructor & Destructor Documentation

◆ Vortex() [1/2]

Vtx::Vortex::Vortex ( )

◆ Vortex() [2/2]

Vtx::Vortex::Vortex ( int2  coords,
double2  coordsD,
int  winding,
bool  isOn,
std::size_t  timeStep 
)

◆ ~Vortex()

Vtx::Vortex::~Vortex ( )

Member Function Documentation

◆ getCoords()

int2 Vtx::Vortex::getCoords ( ) const

◆ getCoordsD()

double2 Vtx::Vortex::getCoordsD ( ) const

◆ getIsOn()

bool Vtx::Vortex::getIsOn ( ) const

◆ getTimeStep()

std::size_t Vtx::Vortex::getTimeStep ( ) const

◆ getUID()

int Vtx::Vortex::getUID ( ) const

◆ getWinding()

int Vtx::Vortex::getWinding ( ) const

◆ updateCoords()

void Vtx::Vortex::updateCoords ( int2  coords)

◆ updateCoordsD()

void Vtx::Vortex::updateCoordsD ( double2  coordsD)

◆ updateIsOn()

void Vtx::Vortex::updateIsOn ( bool  isOn)

◆ updateTimeStep()

void Vtx::Vortex::updateTimeStep ( std::size_t  timeStep)

◆ updateUID()

void Vtx::Vortex::updateUID ( int  uid)

◆ updateWinding()

void Vtx::Vortex::updateWinding ( int  winding)

Friends And Related Function Documentation

◆ VtxList

friend class VtxList
friend

Definition at line 40 of file vort.h.

Member Data Documentation

◆ uid

int Vtx::Vortex::uid
protected

Definition at line 49 of file vort.h.


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