Vec3D Class Reference

Implementation of a 3D vector (by Vitaliy). More...

#include <Vector.h>

Public Member Functions
	Vec3D (void)
	Vec3D (const Mdouble x, const Mdouble y, const Mdouble z)
void	set_zero ()
bool	is_zero ()
Vec3D	operator+ (const Vec3D &A) const
Vec3D	operator- (const Vec3D &A) const
Vec3D	operator+ (const Mdouble A) const
Vec3D	operator- (const Mdouble A) const
Vec3D	operator* (const Mdouble A) const
Vec3D	operator/ (const Mdouble A) const
Vec3D &	operator+= (const Vec3D &A)
Vec3D &	operator-= (const Vec3D &A)
Vec3D &	operator*= (const Mdouble a)
Vec3D &	operator/= (const Mdouble a)
void	normalize ()
void	SetLength (Mdouble length)
Mdouble	GetLength2 () const
Mdouble	getComponent (const int index) const
void	setComponent (int index, double val)
Vec3D	GetCylindricalCoordinates () const
Vec3D	GetFromCylindricalCoordinates ()
Mdouble	GetLength () const

Public Attributes
Mdouble	X
Mdouble	Y
Mdouble	Z

Friends
Mdouble	Dot (const Vec3D &A, const Vec3D &B)
Vec3D	max (const Vec3D &A, const Vec3D &B)
Vec3D	min (const Vec3D &A, const Vec3D &B)
Vec3D	square (const Vec3D &A)
Vec3D	sqrt (const Vec3D &A)
Vec3D	Cross (const Vec3D &A, const Vec3D &B)
Mdouble	GetDistance (const Vec3D &A, const Vec3D &B)
Mdouble	GetDistance2 (const Vec3D &A, const Vec3D &B)
Mdouble	GetLength2 (const Vec3D &A)
Mdouble	GetLength (const Vec3D &A)
Vec3D	GetUnitVector (const Vec3D &A)
std::ostream &	operator<< (std::ostream &os, const Vec3D &A)
std::istream &	operator>> (std::istream &is, Vec3D &A)
Vec3D	operator+ (const Mdouble &a, const Vec3D &A)
Vec3D	operator- (const Mdouble &a, const Vec3D &A)
Vec3D	operator- (const Vec3D &A)
Vec3D	operator* (const Mdouble &a, const Vec3D &A)

Detailed Description

Implementation of a 3D vector (by Vitaliy).

Modifications 21:9:2009 - Added the inclusion guards and some include objects

Todo:

Need to generise this to n-dimensional vectors of any type

Definition at line 40 of file Vector.h.

Constructor & Destructor Documentation

Vec3D::Vec3D ( void  )

inline

Definition at line 46 of file Vector.h.

References set_zero().

Referenced by GetCylindricalCoordinates(), GetFromCylindricalCoordinates(), operator*(), operator+(), operator-(), and operator/().

                      {
        set_zero();
    }

Vec3D::Vec3D ( const Mdouble  x, const Mdouble  y, const Mdouble  z  )

inline

Definition at line 50 of file Vector.h.

References X, Y, and Z.

    {   
        X = x; Y = y; Z = z;
    }

Member Function Documentation

Mdouble Vec3D::getComponent ( const int  index ) const

inline

Definition at line 193 of file Vector.h.

References X, Y, and Z.

    {
        switch(index)
        {
            case 0:
                return X;
            case 1:
                return Y;
            case 2:
                return Z;
            default:
                std::cerr<<"Index="<<index<<" is to high for 3D vector"<<std::endl;
                exit(-1);
        }
    }

Vec3D Vec3D::GetCylindricalCoordinates ( ) const

inline

Definition at line 228 of file Vector.h.

References sqrt, Vec3D(), X, Y, and Z.

    {
        return Vec3D(sqrt(X * X + Y * Y), atan2(Y, X), Z);
    }

Vec3D Vec3D::GetFromCylindricalCoordinates ( )

inline

Definition at line 233 of file Vector.h.

References Vec3D(), X, Y, and Z.

    {
        return Vec3D(X * cos(Y), X * sin(Y), Z);
    }

Mdouble Vec3D::GetLength ( ) const

inline

Definition at line 248 of file Vector.h.

References GetLength2(), and sqrt.

Referenced by StatisticsPoint< T >::CG_integral(), StatisticsPoint< T >::CG_integral_2D(), StatisticsPoint< T >::CG_integral_gradient(), MD::compute_internal_forces(), MD::compute_plastic_internal_forces(), MD::compute_walls(), CylinderTransformer(), MD::do_integration_before_force_computation(), FiniteAxisSymmetricWall::get_distance_and_normal(), CylindricalWall::get_distance_and_normal(), Coil::get_distance_and_normal(), Screw::get_distance_and_normal(), InfiniteWallWithHole::get_distance_and_normal(), normalize(), Chute::set_ChuteAngle(), and SetLength().

    {
        return sqrt(GetLength2());
    }

Mdouble Vec3D::GetLength2 ( ) const

inline

Definition at line 188 of file Vector.h.

References X, Y, and Z.

Referenced by GetLength().

    {
        return (X * X + Y * Y + Z * Z);
    }

bool Vec3D::is_zero ( )

inline

Definition at line 60 of file Vector.h.

References X, Y, and Z.

Referenced by FiniteAxisSymmetricWall::get_distance_and_normal().

    {   
        return X == 0.0 && Y == 0.0 && Z == 0.0;
    }

void Vec3D::normalize ( )

inline

Definition at line 152 of file Vector.h.

References GetLength().

Referenced by FiniteAxisSymmetricWall::setSymmetryAxis().

                            {
        *this  /= this->GetLength();
    }

Vec3D Vec3D::operator* ( const Mdouble  A ) const

inline

Definition at line 85 of file Vector.h.

References Vec3D(), X, Y, and Z.

    { 
        return Vec3D(X * A, Y * A, Z * A); 
    }

Vec3D& Vec3D::operator*= ( const Mdouble  a )

inline

Definition at line 111 of file Vector.h.

References X, Y, and Z.

    {
        X *= a;
        Y *= a;
        Z *= a;
        return *this;
    }

Vec3D Vec3D::operator+ ( const Vec3D &  A ) const

inline

Definition at line 65 of file Vector.h.

References Vec3D(), X, Y, and Z.

    { 
        return Vec3D(X + A.X, Y + A.Y, Z + A.Z); 
    }

Vec3D Vec3D::operator+ ( const Mdouble  A ) const

inline

Definition at line 75 of file Vector.h.

References Vec3D(), X, Y, and Z.

    { 
        return Vec3D(X + A, Y + A, Z + A); 
    }

Vec3D& Vec3D::operator+= ( const Vec3D &  A )

inline

Definition at line 95 of file Vector.h.

References X, Y, and Z.

    {
        X += A.X;
        Y += A.Y;
        Z += A.Z;
        return *this;
    }

Vec3D Vec3D::operator- ( const Vec3D &  A ) const

inline

Definition at line 70 of file Vector.h.

References Vec3D(), X, Y, and Z.

    {
        return Vec3D(X - A.X, Y - A.Y, Z - A.Z);
    }

Vec3D Vec3D::operator- ( const Mdouble  A ) const

inline

Definition at line 80 of file Vector.h.

References Vec3D(), X, Y, and Z.

    { 
        return Vec3D(X - A, Y - A, Z - A); 
    }

Vec3D& Vec3D::operator-= ( const Vec3D &  A )

inline

Definition at line 103 of file Vector.h.

References X, Y, and Z.

    {
        X -= A.X;
        Y -= A.Y;
        Z -= A.Z;
        return *this;
    }

Vec3D Vec3D::operator/ ( const Mdouble  A ) const

inline

Definition at line 90 of file Vector.h.

References Vec3D(), X, Y, and Z.

    { 
        return Vec3D(X / A, Y / A, Z / A); 
    }

Vec3D& Vec3D::operator/= ( const Mdouble  a )

inline

Definition at line 119 of file Vector.h.

References X, Y, and Z.

    {
        X /= a;
        Y /= a;
        Z /= a;
        return *this;
    }

void Vec3D::set_zero ( )

inline

Definition at line 55 of file Vector.h.

References X, Y, and Z.

Referenced by BaseParticle::BaseParticle(), BaseWall::BaseWall(), FiniteWall::clear(), InfiniteWall::clear(), InfiniteWallWithHole::clear(), Coil::Coil(), MD::compute_internal_forces(), MD::compute_plastic_internal_forces(), MD::compute_walls(), CTangentialSpring::CTangentialSpring(), FiniteAxisSymmetricWall::FiniteAxisSymmetricWall(), BaseParticle::fixParticle(), InfiniteWallWithHole::InfiniteWallWithHole(), Screw::Screw(), StatisticsPoint< T >::StatisticsPoint(), and Vec3D().

    {   
        X = 0.0; Y = 0.0; Z = 0.0;
    }

void Vec3D::setComponent ( int  index, double  val  )

inline

Definition at line 209 of file Vector.h.

References X, Y, and Z.

    {
        switch(index)
        {
            case 0:
                X=val;
                return;
            case 1:
                Y=val;
                return;
            case 2:
                Z=val;
                return;
            default:
                std::cerr<<"Index="<<index<<" is to high for 3D vector"<<std::endl;
                exit(-1);
        }
    }    

void Vec3D::SetLength ( Mdouble  length )

inline

Definition at line 157 of file Vector.h.

References GetLength().

                                          {
        *this  /= this->GetLength()*length;
    }

Friends And Related Function Documentation

Vec3D Cross ( const Vec3D &  A, const Vec3D &  B  )

friend

Definition at line 168 of file Vector.h.

    {
        return Vec3D(A.Y*B.Z-A.Z*B.Y, A.Z*B.X-A.X*B.Z, A.X*B.Y-A.Y*B.X);
    }

Mdouble Dot ( const Vec3D &  A, const Vec3D &  B  )

friend

Definition at line 128 of file Vector.h.

    {
        return A.X * B.X + A.Y * B.Y + A.Z * B.Z;
    }

Mdouble GetDistance ( const Vec3D &  A, const Vec3D &  B  )

friend

Definition at line 173 of file Vector.h.

    {
        return sqrt(GetDistance2(A, B));
    }

Mdouble GetDistance2 ( const Vec3D &  A, const Vec3D &  B  )

friend

Definition at line 178 of file Vector.h.

    {
        return ((A.X - B.X) * (A.X - B.X) + (A.Y - B.Y) * (A.Y - B.Y) + (A.Z - B.Z) * (A.Z - B.Z));
    }

Mdouble GetLength ( const Vec3D &  A )

friend

Definition at line 253 of file Vector.h.

    {
        return A.GetLength();
    }

Mdouble GetLength2 ( const Vec3D &  A )

friend

Definition at line 183 of file Vector.h.

Referenced by ChuteWithHopperAndInset::add_hopper(), ChuteWithHopper::add_hopper(), ChuteWithHopperAndInset::add_Inset(), MD::compute_internal_forces(), MD::compute_plastic_internal_forces(), MD::compute_walls(), PeriodicBoundary::get_close_together(), FiniteWall::get_distance_and_normal(), BaseParticle::get_KineticEnergy(), InfiniteWall::print(), InfiniteWallWithHole::print(), and FiniteWall::print().

    {
        return (A.X * A.X + A.Y * A.Y + A.Z * A.Z);
    }

Vec3D GetUnitVector ( const Vec3D &  A )

friend

Definition at line 258 of file Vector.h.

    {
        Mdouble Length2 = A.GetLength2();
        if (Length2) return A/sqrt(Length2);
        else return Vec3D(0,0,0);
    }

Vec3D max ( const Vec3D &  A, const Vec3D &  B  )

friend

Definition at line 134 of file Vector.h.

    {
        return Vec3D(std::max(A.X,B.X), std::max(A.Y,B.Y), std::max(A.Z,B.Z));
    }

Vec3D min ( const Vec3D &  A, const Vec3D &  B  )

friend

Definition at line 140 of file Vector.h.

    {
        return Vec3D(std::min(A.X,B.X), std::min(A.Y,B.Y), std::min(A.Z,B.Z));
    }

Vec3D operator* ( const Mdouble &  a, const Vec3D &  A  )

friend

Definition at line 280 of file Vector.h.

{return Vec3D(A.X * a, A.Y * a, A.Z * a);}  

Vec3D operator+ ( const Mdouble &  a, const Vec3D &  A  )

friend

Definition at line 277 of file Vector.h.

{return Vec3D(A.X + a, A.Y + a, A.Z + a);} 

Vec3D operator- ( const Mdouble &  a, const Vec3D &  A  )

friend

Definition at line 278 of file Vector.h.

{return Vec3D(A.X - a, A.Y - a, A.Z - a);} 

Vec3D operator- ( const Vec3D &  A )

friend

Definition at line 279 of file Vector.h.

{return Vec3D(-A.X, -A.Y, -A.Z);} 

std::ostream& operator<< ( std::ostream &  os, const Vec3D &  A  )

friend

Definition at line 265 of file Vector.h.

    {
        os << A.X << ' ' << A.Y << ' ' << A.Z;
        return os;
    }

std::istream& operator>> ( std::istream &  is, Vec3D &  A  )

friend

Definition at line 271 of file Vector.h.

    {
        is >> A.X >> A.Y >> A.Z;
        return is;
    }

Vec3D sqrt ( const Vec3D &  A )

friend

Definition at line 162 of file Vector.h.

Referenced by GetCylindricalCoordinates(), and GetLength().

    {
        return Vec3D(sqrt(A.X), sqrt(A.Y), sqrt(A.Z));
    }

Vec3D square ( const Vec3D &  A )

friend

Definition at line 146 of file Vector.h.

    {
        return Vec3D(A.X * A.X, A.Y * A.Y, A.Z * A.Z);
    }

Member Data Documentation

Mdouble Vec3D::X

Definition at line 44 of file Vector.h.

Referenced by ChuteWithHopperAndInset::add_hopper(), ChuteWithHopper::add_hopper(), ChuteWithHopperAndInset::add_Inset(), StatisticsPoint< T >::CG_function(), StatisticsPoint< T >::CG_gradient(), StatisticsPoint< T >::CG_integral(), InsertionBoundary::checkBoundaryActionsBeforeTimeStep(), CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), HGRID_2D::CheckObjAgainstGrid(), HGRID_3D::CheckObjAgainstGrid(), Chute::clean_chute(), StatisticsPoint< T >::clearAveragedDirections(), Chute::create_bottom(), Chute::create_inflow_particle(), CircularPeriodicBoundary::createPeriodicParticles(), StatisticsPoint< T >::cross(), Cross(), CylinderTransformer(), StatisticsPoint< T >::dot(), Dyadic(), StatisticsVector< T >::evaluate_force_statistics(), StatisticsVector< T >::evaluate_particle_statistics(), StatisticsVector< T >::evaluate_wall_force_statistics(), Export_to_VRML_format2(), BaseParticle::get_Displacement2(), StatisticsPoint< T >::get_distance2(), FiniteAxisSymmetricWall::get_distance_and_normal(), CylindricalWall::get_distance_and_normal(), Coil::get_distance_and_normal(), Screw::get_distance_and_normal(), InfiniteWallWithHole::get_distance_and_normal(), InfiniteWallWithHole::get_holeDistance(), getComponent(), GetCylindricalCoordinates(), GetFromCylindricalCoordinates(), GetLength2(), StatisticsVector< T >::getVelocityProfile(), HGRID_2D::HGRID_UpdateParticleInHgrid(), HGRID_3D::HGRID_UpdateParticleInHgrid(), is_zero(), StatisticsVector< T >::loadVelocityProfile(), StatisticsPoint< T >::MatrixCross(), TangentialSpringParticle::oldRead(), operator*(), Matrix3D::operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), MD::output_xballs_data_particle(), MD::read_next_from_data_file(), CircularPeriodicBoundary::rotateParticle(), StatisticsVector< T >::set_Positions(), set_zero(), setComponent(), ChuteBottom::setup_particles_initial_conditions(), SymmetrizedDyadic(), HGRID_2D::TestObjAgainstGrid(), HGRID_3D::TestObjAgainstGrid(), and Vec3D().

Mdouble Vec3D::Y

Definition at line 44 of file Vector.h.

Referenced by StatisticsPoint< T >::CG_function(), StatisticsPoint< T >::CG_gradient(), StatisticsPoint< T >::CG_integral(), InsertionBoundary::checkBoundaryActionsBeforeTimeStep(), CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), HGRID_2D::CheckObjAgainstGrid(), HGRID_3D::CheckObjAgainstGrid(), StatisticsPoint< T >::clearAveragedDirections(), Chute::create_bottom(), Chute::create_inflow_particle(), CircularPeriodicBoundary::createPeriodicParticles(), StatisticsPoint< T >::cross(), Cross(), CylinderTransformer(), StatisticsPoint< T >::dot(), Dyadic(), StatisticsVector< T >::evaluate_force_statistics(), StatisticsVector< T >::evaluate_particle_statistics(), StatisticsVector< T >::evaluate_wall_force_statistics(), Export_to_VRML_format2(), BaseParticle::get_Displacement2(), StatisticsPoint< T >::get_distance2(), FiniteAxisSymmetricWall::get_distance_and_normal(), CylindricalWall::get_distance_and_normal(), Coil::get_distance_and_normal(), Screw::get_distance_and_normal(), InfiniteWallWithHole::get_distance_and_normal(), InfiniteWallWithHole::get_holeDistance(), getComponent(), GetCylindricalCoordinates(), GetFromCylindricalCoordinates(), GetLength2(), StatisticsVector< T >::getVelocityProfile(), HGRID_2D::HGRID_UpdateParticleInHgrid(), HGRID_3D::HGRID_UpdateParticleInHgrid(), is_zero(), StatisticsVector< T >::loadVelocityProfile(), StatisticsPoint< T >::MatrixCross(), TangentialSpringParticle::oldRead(), operator*(), Matrix3D::operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), MD::output_xballs_data_particle(), MD::read_next_from_data_file(), CircularPeriodicBoundary::rotateParticle(), StatisticsVector< T >::set_Positions(), set_zero(), setComponent(), ChuteBottom::setup_particles_initial_conditions(), SymmetrizedDyadic(), HGRID_2D::TestObjAgainstGrid(), HGRID_3D::TestObjAgainstGrid(), and Vec3D().

Mdouble Vec3D::Z

Definition at line 44 of file Vector.h.

Referenced by ChuteWithHopperAndInset::add_hopper(), ChuteWithHopper::add_hopper(), ChuteWithHopperAndInset::add_Inset(), StatisticsPoint< T >::CG_function(), StatisticsPoint< T >::CG_gradient(), StatisticsPoint< T >::CG_integral(), InsertionBoundary::checkBoundaryActionsBeforeTimeStep(), HGRID_3D::CheckObjAgainstGrid(), StatisticsPoint< T >::clearAveragedDirections(), Chute::create_inflow_particle(), StatisticsPoint< T >::cross(), Cross(), CylinderTransformer(), StatisticsPoint< T >::dot(), Dyadic(), StatisticsVector< T >::evaluate_force_statistics(), StatisticsVector< T >::evaluate_particle_statistics(), StatisticsVector< T >::evaluate_wall_force_statistics(), Export_to_VRML_format2(), StatisticsVector< T >::gather_statistics_collision(), BaseParticle::get_Displacement2(), StatisticsPoint< T >::get_distance2(), FiniteAxisSymmetricWall::get_distance_and_normal(), CylindricalWall::get_distance_and_normal(), Coil::get_distance_and_normal(), Screw::get_distance_and_normal(), InfiniteWallWithHole::get_distance_and_normal(), getComponent(), GetCylindricalCoordinates(), GetFromCylindricalCoordinates(), GetLength2(), StatisticsVector< T >::getVelocityProfile(), HGRID_3D::HGRID_UpdateParticleInHgrid(), is_zero(), StatisticsVector< T >::loadVelocityProfile(), StatisticsPoint< T >::MatrixCross(), TangentialSpringParticle::oldRead(), operator*(), Matrix3D::operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), MD::output_xballs_data_particle(), MD::read_next_from_data_file(), CircularPeriodicBoundary::rotateParticle(), StatisticsVector< T >::satisfiesInclusionCriteria(), StatisticsVector< T >::set_Positions(), set_zero(), setComponent(), ChuteBottom::setup_particles_initial_conditions(), SymmetrizedDyadic(), HGRID_3D::TestObjAgainstGrid(), and Vec3D().

---

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

• Vector.h