asl::TemplateVE Class Reference

This class contains VectorOfElements which corresponds to values of a field in littice nodes. More...

`#include <aslTemplateVE.h>`

Collaboration diagram for asl::TemplateVE:
[legend]

## Public Member Functions

| TemplateVE (AbstractDataWithGhostNodes &data, const VectorTemplate &vectorT, unsigned int i=0, bool bIni=true)
| TemplateVE (DistanceFunction &data, acl::VectorOfElements &position, const VectorTemplate &vectorT, unsigned int i=0)
| TemplateVE (const acl::VectorOfElements &val, const VectorTemplate &vectorT)
| this is used for matematical operations with TemplateVE More...
| TemplateVE ()
acl::VectorOfElements | getValue (unsigned int i)
void | init (AbstractDataWithGhostNodes &data, const VectorTemplate &vectorT, unsigned int i=0, bool bIni=true)
void | init (DistanceFunction &data, acl::VectorOfElements &position, const VectorTemplate &vectorT, unsigned int i=0)
| TemplateVE (AbstractDataWithGhostNodes &data, const VectorTemplate &vectorT, unsigned int i=0, bool bIni=true)
| TemplateVE (DistanceFunction &data, acl::VectorOfElements &position, const VectorTemplate &vectorT, unsigned int i=0)
| TemplateVE (const acl::VectorOfElements &val, const VectorTemplate &vectorT)
| this is used for matematical operations with TemplateVE More...
| TemplateVE ()
acl::VectorOfElements | getValue (unsigned int i)
void | init (AbstractDataWithGhostNodes &data, const VectorTemplate &vectorT, unsigned int i=0, bool bIni=true)
void | init (DistanceFunction &data, acl::VectorOfElements &position, const VectorTemplate &vectorT, unsigned int i=0)

## Public Attributes

const VectorTemplate * | vectorTemplate
const VTObjects * | vto
acl::VectorOfElements | values
acl::VectorOfElements | initValues

## Detailed Description

This class contains VectorOfElements which corresponds to values of a field in littice nodes.

This class contains VectorOfElements (VE) with PrivateVariables. This list should be added to the kernel before use as follows:

Kernel kernel;
TemplateVE a;
kernel<<a.initValues;
asl::TemplateVE::TemplateVE
TemplateVE()

Definition at line 51 of file aslTemplateVE.h.

## Constructor & Destructor Documentation

## TemplateVE() [1/8]

asl::TemplateVE::TemplateVE | ( | AbstractDataWithGhostNodes & | data,
|  | const VectorTemplate & | vectorT,
|  | unsigned int | i = `0`,
|  | bool | bIni = `true`
| ) |  |

Parameters

  data | is a data field
  vectorT | is a tempate vector
  i | is the number of component (for a case with multicomponent data)
  bIni | incase of true it generates private variable for storage otherwise it uses direct acces

## TemplateVE() [2/8]

asl::TemplateVE::TemplateVE | ( | DistanceFunction & | data,
|  | acl::VectorOfElements & | position,
|  | const VectorTemplate & | vectorT,
|  | unsigned int | i = `0`
| ) |  |

Parameters

  data | is a data field
  position | contains current position (not index)
  vectorT | is a tempate vector
  i | is the number of component (for a case with multicomponent data)

## TemplateVE() [3/8]

asl::TemplateVE::TemplateVE | ( | const acl::VectorOfElements & | val,
|  | const VectorTemplate & | vectorT
| ) |  |

this is used for matematical operations with TemplateVE

## TemplateVE() [4/8]

asl::TemplateVE::TemplateVE | ( |  | ) |

## TemplateVE() [5/8]

asl::TemplateVE::TemplateVE | ( | AbstractDataWithGhostNodes & | data,
|  | const VectorTemplate & | vectorT,
|  | unsigned int | i = `0`,
|  | bool | bIni = `true`
| ) |  |

Parameters

  data | is a data field
  vectorT | is a tempate vector
  i | is the number of component (for a case with multicomponent data)
  bIni | incase of true it generates private variable for storage otherwise it uses direct acces

## TemplateVE() [6/8]

asl::TemplateVE::TemplateVE | ( | DistanceFunction & | data,
|  | acl::VectorOfElements & | position,
|  | const VectorTemplate & | vectorT,
|  | unsigned int | i = `0`
| ) |  |

Parameters

  data | is a data field
  position | contains current position (not index)
  vectorT | is a tempate vector
  i | is the number of component (for a case with multicomponent data)

## TemplateVE() [7/8]

asl::TemplateVE::TemplateVE | ( | const acl::VectorOfElements & | val,
|  | const VectorTemplate & | vectorT
| ) |  |

this is used for matematical operations with TemplateVE

## TemplateVE() [8/8]

asl::TemplateVE::TemplateVE | ( |  | ) |

## Member Function Documentation

## getValue() [1/2]

acl::VectorOfElements asl::TemplateVE::getValue | ( | unsigned int | i | ) |

## getValue() [2/2]

acl::VectorOfElements asl::TemplateVE::getValue | ( | unsigned int | i | ) |

## init() [1/4]

void asl::TemplateVE::init | ( | AbstractDataWithGhostNodes & | data,
|  | const VectorTemplate & | vectorT,
|  | unsigned int | i = `0`,
|  | bool | bIni = `true`
| ) |  |

Note: the init function does not make initialization of values in case whete its length remains the same. this is usefull for reuse of private variables

Parameters

  data | is a data field
  vectorT | is a tempate vector
  i | is the number of component (for a case with multicomponent data)
  bIni | incase of true it generates private variable for storage otherwise it uses direct acces

## init() [2/4]

void asl::TemplateVE::init | ( | AbstractDataWithGhostNodes & | data,
|  | const VectorTemplate & | vectorT,
|  | unsigned int | i = `0`,
|  | bool | bIni = `true`
| ) |  |

Note: the init function does not make initialization of values in case whete its length remains the same. this is usefull for reuse of private variables

Parameters

  data | is a data field
  vectorT | is a tempate vector
  i | is the number of component (for a case with multicomponent data)
  bIni | incase of true it generates private variable for storage otherwise it uses direct acces

## init() [3/4]

void asl::TemplateVE::init | ( | DistanceFunction & | data,
|  | acl::VectorOfElements & | position,
|  | const VectorTemplate & | vectorT,
|  | unsigned int | i = `0`
| ) |  |

Note: the init function does not make initialization of values in case whete its length remains the same. this is usefull for reuse of private variables

Todo:
  Fnish!!! not distance functino but Position function

## init() [4/4]

void asl::TemplateVE::init | ( | DistanceFunction & | data,
|  | acl::VectorOfElements & | position,
|  | const VectorTemplate & | vectorT,
|  | unsigned int | i = `0`
| ) |  |

Note: the init function does not make initialization of values in case whete its length remains the same. this is usefull for reuse of private variables

Todo:
  Fnish!!! not distance functino but Position function

## Member Data Documentation

## initValues

acl::VectorOfElements asl::TemplateVE::initValues

Definition at line 57 of file aslTemplateVE.h.

## values

acl::VectorOfElements asl::TemplateVE::values

Definition at line 56 of file aslTemplateVE.h.

## vectorTemplate

const VectorTemplate * asl::TemplateVE::vectorTemplate

Definition at line 54 of file aslTemplateVE.h.

## vto

const VTObjects * asl::TemplateVE::vto

Definition at line 55 of file aslTemplateVE.h.

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

- /build/asl-1Fw6fH/asl-0.1.7/debian/tmp/usr/include/ASL/math/aslTemplateVE.h