VEE_VectorGrid Class Reference

Force vectors stored into a grid. More...

#include <vee_grid_force.h>

List of all members.

Public Types

• typedef MJ_Array3D< VEE_VectorGridCell > grid3d

Public Member Functions

• VEE_VectorGrid ()
• virtual ~VEE_VectorGrid ()
• VEE_VectorGridCell getGradient (const VEE_Vector3 &) const

  Gets the gradient and alpha in location loc01.
  

• VEE_VectorGridCell interpolateGradient (const VEE_Vector3 &) const
• const float & scale () const
• float meanDistance ()
• float meanGradientLength ()
• bool createFromModel (Solar_Model *m, uint division, int blurRepeats, int blurRadius, int pad=-1)

  Creates a grid from a model.
  

• bool createFromModel (GEE_Group *m, uint division, int blurRepeats, int blurRadius, int pad=-1)
• bool createFromModel2 (Solar_Model *m, uint division, int blurRepeats, int blurRadius)
• bool writeGridToFile (const char *)
• bool readGridFromFile (const char *)
• bool writeAsciiFile (const char *, int selectLayer=-1) const

  Stores the field into an ASCII file.
  

• grid3d & grid ()
• int layers () const
• int rows () const
• int cols () const

Static Public Member Functions

• static bool fromModelToFile (const char *fieldFile, const char *solarModel, int division, int blurRepeats, int blurRadius, int method)
• static void setDebug (bool b)

Protected Member Functions

• bool createFromGrid (JanneGrid3 *, const VEE_Vector3 &low, const VEE_Vector3 &high, uint division, int blurRepeats, int blurRadius, int pad)
• bool createFromGrid2 (JanneGrid3 *, const VEE_Vector3 &low, const VEE_Vector3 &high, uint division, int blurRepeats, int blurRadius)
• void setInsides (JanneGrid3 *)

  Sets the inside / outside information of each cell.
  

Protected Attributes

• grid3d m_field
• float m_scale

  Scaling factor used to get from world coordinates to voxel indices.
  

Static Protected Attributes

• static bool m_debug = true

Classes

• class JanneGrid3

  This is a class that hides the stuff coming from "Grid.hpp". More...
  

---

Detailed Description

Force vectors stored into a grid.

---

Member Typedef Documentation

typedef MJ_Array3D<VEE_VectorGridCell> VEE_VectorGrid::grid3d

---

Constructor & Destructor Documentation

VEE_VectorGrid::VEE_VectorGrid (   )

VEE_VectorGrid::~VEE_VectorGrid (   )  [virtual]

---

Member Function Documentation

VEE_VectorGridCell VEE_VectorGrid::getGradient (  const VEE_Vector3 &  location  )  const

Gets the gradient and alpha in location loc01. The location is expected in the original object coordinates range.

VEE_VectorGridCell VEE_VectorGrid::interpolateGradient (  const VEE_Vector3 &   )  const

const float& VEE_VectorGrid::scale (   )  const [inline]

float VEE_VectorGrid::meanDistance (   )

float VEE_VectorGrid::meanGradientLength (   )

bool VEE_VectorGrid::createFromModel (  Solar_Model *  m, uint  division, int  blurRepeats, int  blurRadius, int  pad = -1 )

Creates a grid from a model.

bool VEE_VectorGrid::createFromModel (  GEE_Group *  m, uint  division, int  blurRepeats, int  blurRadius, int  pad = -1 )

bool VEE_VectorGrid::createFromModel2 (  Solar_Model *  m, uint  division, int  blurRepeats, int  blurRadius )

bool VEE_VectorGrid::writeGridToFile (  const char *   )

bool VEE_VectorGrid::readGridFromFile (  const char *   )

bool VEE_VectorGrid::writeAsciiFile (  const char *  filename, int  selectLayer = -1 )  const

Stores the field into an ASCII file. Use Matlab or something to load the file and plot the contents to the screen.

bool VEE_VectorGrid::fromModelToFile (  const char *  fieldFile, const char *  solarModel, int  division, int  blurRepeats, int  blurRadius, int  method )  [static]

static void VEE_VectorGrid::setDebug (  bool  b  )  [inline, static]

grid3d& VEE_VectorGrid::grid (   )  [inline]

int VEE_VectorGrid::layers (   )  const [inline]

int VEE_VectorGrid::rows (   )  const [inline]

int VEE_VectorGrid::cols (   )  const [inline]

bool VEE_VectorGrid::createFromGrid (  JanneGrid3 *  , const VEE_Vector3 &  low, const VEE_Vector3 &  high, uint  division, int  blurRepeats, int  blurRadius, int  pad )  [protected]

bool VEE_VectorGrid::createFromGrid2 (  JanneGrid3 *  , const VEE_Vector3 &  low, const VEE_Vector3 &  high, uint  division, int  blurRepeats, int  blurRadius )  [protected]

void VEE_VectorGrid::setInsides (  JanneGrid3 *   )  [protected]

Sets the inside / outside information of each cell.

---

Member Data Documentation

grid3d VEE_VectorGrid::m_field [protected]

float VEE_VectorGrid::m_scale [protected]

Scaling factor used to get from world coordinates to voxel indices. Span of the object in world coordinates.

bool VEE_VectorGrid::m_debug = true [static, protected]

---

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

• vee_grid_force.h
• vee_grid_force.C

---