SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Member Functions | Private Attributes
Vertex Class Reference

Defines an n-dimensional vertex and its mapping onto a sclar field. More...

#include <Vertex.hh>

Public Member Functions

 Vertex ()
 Default constructor, initilizes everything to 0. More...
 
 Vertex (const std::vector< double > &coords, const double &value=1., const std::vector< size_t > &indices=std::vector< size_t >())
 Normal constructor, sets vector of coordinates and its mapping. More...
 
 Vertex (const size_t n)
 Size constructor, sets vector size. More...
 
 Vertex (const Vertex &vertex)
 Copy constructor. More...
 
Vertex & operator= (const Vertex &vertex)
 Equality operator. More...
 
double & operator[] (const size_t id)
 Returns the id^th component of the vector field at which the vertex is defined. More...
 
const double & operator[] (const size_t id) const
 Returns the id^th component of the vector field at which the vertex is defined. More...
 
 ~Vertex ()
 Destructor. More...
 
const size_t size () const
 Returns the dimension of the vector field in which the vertex is defined. More...
 
const std::vector< double > & GetCoordinates () const
 Returns the coordinates of the vertex. More...
 
void SetCoordinates (const std::vector< double > &coords)
 Returns the coordinates of the vertex. More...
 
const double & GetValue () const
 Returns the value of the field at the vertex. More...
 
void SetValue (const double &value)
 Returns the value of the field at the vertex. More...
 
const size_t GetDimension () const
 Returns the dimension of space in which the vertex lives. More...
 
const std::vector< size_t > & GetIndices () const
 Returns the value of the field at the vertex. More...
 
void SetIndices (const std::vector< size_t > &indices)
 Returns the value of the field at the vertex. More...
 
double GetNorm () const
 Returns the L2 vector norm of the position vector. More...
 

Private Attributes

std::vector< double > _coords
 n-vector, position of the vertex More...
 
double _value
 Value of the scalar field in the vertex. More...
 
std::vector< size_t > _indices
 n-vector, indices of the point within a grid More...
 

Detailed Description

Defines an n-dimensional vertex and its mapping onto a sclar field.

If the verte is on a Grid, it stores the Grid indices.

Constructor & Destructor Documentation

Vertex::Vertex ( )

Default constructor, initilizes everything to 0.

Vertex::Vertex ( const std::vector< double > &  coords,
const double &  value = 1.,
const std::vector< size_t > &  indices = std::vector<size_t>() 
)

Normal constructor, sets vector of coordinates and its mapping.

Parameters
coordsCoordinates of the vertex
valueMapping of the scalar field in the vertex
indicesSet of indices that specifies the position of the vertex on the grid
Vertex::Vertex ( const size_t  n)

Size constructor, sets vector size.

Vertex::Vertex ( const Vertex &  vertex)

Copy constructor.

Vertex::~Vertex ( )

Destructor.

Member Function Documentation

const std::vector<double>& Vertex::GetCoordinates ( ) const
inline

Returns the coordinates of the vertex.

const size_t Vertex::GetDimension ( ) const
inline

Returns the dimension of space in which the vertex lives.

const std::vector<size_t>& Vertex::GetIndices ( ) const
inline

Returns the value of the field at the vertex.

double Vertex::GetNorm ( ) const

Returns the L2 vector norm of the position vector.

const double& Vertex::GetValue ( ) const
inline

Returns the value of the field at the vertex.

Vertex & Vertex::operator= ( const Vertex &  vertex)

Equality operator.

double& Vertex::operator[] ( const size_t  id)
inline

Returns the id^th component of the vector field at which the vertex is defined.

const double& Vertex::operator[] ( const size_t  id) const
inline

Returns the id^th component of the vector field at which the vertex is defined.

void Vertex::SetCoordinates ( const std::vector< double > &  coords)
inline

Returns the coordinates of the vertex.

void Vertex::SetIndices ( const std::vector< size_t > &  indices)
inline

Returns the value of the field at the vertex.

void Vertex::SetValue ( const double &  value)
inline

Returns the value of the field at the vertex.

const size_t Vertex::size ( ) const
inline

Returns the dimension of the vector field in which the vertex is defined.

Field Documentation

std::vector<double> Vertex::_coords
private

n-vector, position of the vertex

std::vector<size_t> Vertex::_indices
private

n-vector, indices of the point within a grid

double Vertex::_value
private

Value of the scalar field in the vertex.


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