The ChainCon Software (Release 0.03)
Public Types | Static Public Member Functions | Static Private Attributes | List of all members
SettableWrapping< CoordT > Class Template Reference

A simple class for wrapping cubical cell coordinstes, using the one defined in the CHomP package. More...

#include <wrapping.h>

Public Types

typedef CoordT CoordType
 The type of coordinates for wrapping. More...
 

Static Public Member Functions

template<class ArrayT >
static void wrap (ArrayT &coords, int dim)
 Makes a correction to the given array of coordinates if wrapping is in effect. More...
 
template<class ArrayT >
static void setWrapping (const ArrayT &coords, int dim)
 Sets wrapping for all spaces of the given dimension. More...
 

Static Private Attributes

static std::vector< std::vector< CoordT > > wrapping
 An array of wrapping vectors for each dimension where defined. More...
 

Detailed Description

template<class CoordT>
class SettableWrapping< CoordT >

A simple class for wrapping cubical cell coordinstes, using the one defined in the CHomP package.

Definition at line 92 of file wrapping.h.

Member Typedef Documentation

◆ CoordType

template<class CoordT >
typedef CoordT SettableWrapping< CoordT >::CoordType

The type of coordinates for wrapping.

Definition at line 96 of file wrapping.h.

Member Function Documentation

◆ setWrapping()

template<class CoordT >
template<class ArrayT >
void SettableWrapping< CoordT >::setWrapping ( const ArrayT &  coords,
int  dim 
)
inlinestatic

Sets wrapping for all spaces of the given dimension.

Definition at line 167 of file wrapping.h.

Referenced by SettableWrapping< CoordT >::wrap().

◆ wrap()

template<class CoordT >
template<class ArrayT >
void SettableWrapping< CoordT >::wrap ( ArrayT &  coords,
int  dim 
)
inlinestatic

Makes a correction to the given array of coordinates if wrapping is in effect.

Definition at line 122 of file wrapping.h.

References SettableWrapping< CoordT >::setWrapping().

Member Data Documentation

◆ wrapping

template<class CoordT >
std::vector< std::vector< CoordT > > SettableWrapping< CoordT >::wrapping
staticprivate

An array of wrapping vectors for each dimension where defined.

Definition at line 109 of file wrapping.h.


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