GranOO  3.0
A robust and versatile workbench to build 3D dynamic simulations based on the Discrete Element Method
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Friends | List of all members
GranOO3::Geom::Vector Class Reference

#include <Vector.hpp>

Public Member Functions

 Vector ()
 
 Vector (const Vector &v)
 
 Vector (const Vector &v, const Frame &from, const Frame &to)
 
 Vector (const Point &p)
 
 Vector (const Point &p1, const Point &p2)
 
 Vector (double x, double y, double z)
 
 Vector (const double *pt)
 
void clear ()
 
bool is_null () const
 
bool is_nan () const
 
bool is_unit () const
 
Pointto_point ()
 
const Pointto_point () const
 
double & x ()
 
const double & x () const
 
double & y ()
 
const double & y () const
 
double & z ()
 
const double & z () const
 
void set_x (const double &)
 
void set_y (const double &)
 
void set_z (const double &)
 
double get_x () const
 
double get_y () const
 
double get_z () const
 
template<typename Axis >
double & val ()
 
template<typename Axis >
const double & val () const
 
const double & operator() (unsigned int i) const
 
double & operator() (unsigned int i)
 
Vectoroperator= (const Vector &v)
 
void operator+= (const Vector &v)
 
void operator-= (const Vector &v)
 
void operator*= (double k)
 
void operator/= (double k)
 
double squared_norm () const
 
double norm () const
 
double Norm1 () const
 
double normalize ()
 
Vector unit () const
 
void project_on_axis (const Vector &axis)
 
void project_on_plane (const Vector &normal)
 
Vector orthogonal_vector () const
 
std::string info () const
 
void add_glob (const std::string &id)
 

Static Public Member Functions

static Vectorglob (const std::string &id)
 
static std::string class_ID ()
 
static Vectornew_object (const TiXmlElement *el)
 
static const Vectornull ()
 

Public Attributes

Eigen::Matrix< double, 3, 1 > coord
 

Static Public Attributes

static const int N = 3
 

Private Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int)
 

Friends

class boost::serialization::access
 

Constructor & Destructor Documentation

◆ Vector() [1/7]

GranOO3::Geom::Vector::Vector ( )

◆ Vector() [2/7]

GranOO3::Geom::Vector::Vector ( const Vector v)

◆ Vector() [3/7]

GranOO3::Geom::Vector::Vector ( const Vector v,
const Frame from,
const Frame to 
)

◆ Vector() [4/7]

GranOO3::Geom::Vector::Vector ( const Point p)
explicit

◆ Vector() [5/7]

GranOO3::Geom::Vector::Vector ( const Point p1,
const Point p2 
)
explicit

◆ Vector() [6/7]

GranOO3::Geom::Vector::Vector ( double  x,
double  y,
double  z 
)
explicit

◆ Vector() [7/7]

GranOO3::Geom::Vector::Vector ( const double *  pt)
explicit

Member Function Documentation

◆ add_glob()

void GranOO3::Geom::Vector::add_glob ( const std::string &  id)

◆ class_ID()

static std::string GranOO3::Geom::Vector::class_ID ( )
inlinestatic

◆ clear()

void GranOO3::Geom::Vector::clear ( )

◆ get_x()

double GranOO3::Geom::Vector::get_x ( ) const

◆ get_y()

double GranOO3::Geom::Vector::get_y ( ) const

◆ get_z()

double GranOO3::Geom::Vector::get_z ( ) const

◆ glob()

Vector & GranOO3::Geom::Vector::glob ( const std::string &  id)
static

◆ info()

std::string GranOO3::Geom::Vector::info ( ) const

◆ is_nan()

bool GranOO3::Geom::Vector::is_nan ( ) const

◆ is_null()

bool GranOO3::Geom::Vector::is_null ( ) const

◆ is_unit()

bool GranOO3::Geom::Vector::is_unit ( ) const

◆ new_object()

Vector * GranOO3::Geom::Vector::new_object ( const TiXmlElement *  el)
static

◆ norm()

double GranOO3::Geom::Vector::norm ( ) const

◆ Norm1()

double GranOO3::Geom::Vector::Norm1 ( ) const

◆ normalize()

double GranOO3::Geom::Vector::normalize ( )

◆ null()

static const Vector& GranOO3::Geom::Vector::null ( )
inlinestatic

◆ operator()() [1/2]

double& GranOO3::Geom::Vector::operator() ( unsigned int  i)

◆ operator()() [2/2]

const double& GranOO3::Geom::Vector::operator() ( unsigned int  i) const

◆ operator*=()

void GranOO3::Geom::Vector::operator*= ( double  k)

◆ operator+=()

void GranOO3::Geom::Vector::operator+= ( const Vector v)

◆ operator-=()

void GranOO3::Geom::Vector::operator-= ( const Vector v)

◆ operator/=()

void GranOO3::Geom::Vector::operator/= ( double  k)

◆ operator=()

Vector& GranOO3::Geom::Vector::operator= ( const Vector v)

◆ orthogonal_vector()

Vector GranOO3::Geom::Vector::orthogonal_vector ( ) const

◆ project_on_axis()

void GranOO3::Geom::Vector::project_on_axis ( const Vector axis)

◆ project_on_plane()

void GranOO3::Geom::Vector::project_on_plane ( const Vector normal)

◆ serialize()

template<class Archive >
void GranOO3::Geom::Vector::serialize ( Archive &  ar,
const unsigned int   
)
private

◆ set_x()

void GranOO3::Geom::Vector::set_x ( const double &  )

◆ set_y()

void GranOO3::Geom::Vector::set_y ( const double &  )

◆ set_z()

void GranOO3::Geom::Vector::set_z ( const double &  )

◆ squared_norm()

double GranOO3::Geom::Vector::squared_norm ( ) const

◆ to_point() [1/2]

Point& GranOO3::Geom::Vector::to_point ( )

◆ to_point() [2/2]

const Point& GranOO3::Geom::Vector::to_point ( ) const

◆ unit()

Vector GranOO3::Geom::Vector::unit ( ) const

◆ val() [1/2]

template<typename Axis >
double& GranOO3::Geom::Vector::val ( )

◆ val() [2/2]

template<typename Axis >
const double& GranOO3::Geom::Vector::val ( ) const

◆ x() [1/2]

double& GranOO3::Geom::Vector::x ( )

◆ x() [2/2]

const double& GranOO3::Geom::Vector::x ( ) const

◆ y() [1/2]

double& GranOO3::Geom::Vector::y ( )

◆ y() [2/2]

const double& GranOO3::Geom::Vector::y ( ) const

◆ z() [1/2]

double& GranOO3::Geom::Vector::z ( )

◆ z() [2/2]

const double& GranOO3::Geom::Vector::z ( ) const

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Member Data Documentation

◆ coord

Eigen::Matrix<double, 3, 1> GranOO3::Geom::Vector::coord

◆ N

const int GranOO3::Geom::Vector::N = 3
static

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