FEMSuite
Public Member Functions | List of all members
PolarVector Class Reference

This class defines a spherical or polar vector More...

#include <PolarVector.h>

Public Member Functions

Spatial GetRadius () const
 
void SetRadius (const Spatial r)
 
Radian GetTheta () const
 
void SetTheta (const Radian th)
 
void AddToTheta (const Radian dth)
 
Radian GetPhi () const
 
void SetPhi (const Radian phi)
 
void AddToPhi (const Radian dphi)
 
void Construct (Point< Spatial > pF, const Point< Spatial > &p0)
 Constructs the vector from two given points More...
 
Point< Spatial > CalculateTarget (const Point< Spatial > &center) const
 Calculates the target of this vector based on a center More...
 
Point< Spatial > CalculateTarget () const
 Calculates the target of this vector based on a center using the initial center point (if any) More...
 
PolarVector ToUnitVector () const
 
Returns
A unit vector corresponding to this vector

 
PolarVector ToNormal () const
 
Returns
A vector normal to this polar vector

 
CartesianVector ToCartesian () const
 
Returns
A Point corresponing to this vector in cartesian form.

 
Spatial Dot (const PolarVector &other) const
 Calculates the dot product of this vector into another vector More...
 
PolarVector Cross (const PolarVector &vectorB) const
 Calculates the cross product (A x B), where this vector is vector A. More...
 
std::string ToString () const
 
 PolarVector (const Spatial radius, const Radian theta, const Radian phi)
 
 PolarVector (const Point< Spatial > &pF, const Point< Spatial > &p0, const Radian additionalThetaRotation=0, const Radian additionalPhiRotation=0)
 
 PolarVector (const DimensionArray< Spatial > &)
 
 PolarVector (const CartesianVector &)
 

Detailed Description

This class defines a spherical or polar vector

Member Function Documentation

Point< Spatial > PolarVector::CalculateTarget ( const Point< Spatial > &  center) const

Calculates the target of this vector based on a center

Parameters
centerCenter point of this parameter
Point<Spatial> PolarVector::CalculateTarget ( ) const
inline

Calculates the target of this vector based on a center using the initial center point (if any)

void PolarVector::Construct ( Point< Spatial >  pF,
const Point< Spatial > &  p0 
)

Constructs the vector from two given points

PolarVector PolarVector::Cross ( const PolarVector vectorB) const

Calculates the cross product (A x B), where this vector is vector A.

Spatial PolarVector::Dot ( const PolarVector other) const

Calculates the dot product of this vector into another vector


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