Public Member Functions | Private Attributes | List of all members
GeneralEllipse Class Reference

A geometric object for an ellipse with initial centre of mass at (centre_x, centre_y) with axis in the x direction given by 2a and in the y-direction given by 2b. The boundary of the ellipse is parametrised by its angle. More...

Inheritance diagram for GeneralEllipse:

Public Member Functions

 GeneralEllipse (const double &centre_x, const double &centre_y, const double &a, const double &b)
 Simple Constructor that transfers appropriate geometric parameters into internal data. More...
 
 ~GeneralEllipse ()
 Empty Destructor. More...
 
void position (const Vector< double > &xi, Vector< double > &r) const
 
void position (const unsigned &t, const Vector< double > &xi, Vector< double > &r) const
 

Private Attributes

double Centre_x
 
double Centre_y
 
double A
 
double B
 

Detailed Description

A geometric object for an ellipse with initial centre of mass at (centre_x, centre_y) with axis in the x direction given by 2a and in the y-direction given by 2b. The boundary of the ellipse is parametrised by its angle.

Definition at line 149 of file jeffery_orbit.cc.

Constructor & Destructor Documentation

◆ GeneralEllipse()

GeneralEllipse::GeneralEllipse ( const double &  centre_x,
const double &  centre_y,
const double &  a,
const double &  b 
)
inline

Simple Constructor that transfers appropriate geometric parameters into internal data.

Definition at line 160 of file jeffery_orbit.cc.

◆ ~GeneralEllipse()

GeneralEllipse::~GeneralEllipse ( )
inline

Empty Destructor.

Definition at line 166 of file jeffery_orbit.cc.

Member Function Documentation

◆ position() [1/2]

void GeneralEllipse::position ( const Vector< double > &  xi,
Vector< double > &  r 
) const
inline

Return the position of the ellipse boundary as a function of the angle xi[0]

Definition at line 170 of file jeffery_orbit.cc.

◆ position() [2/2]

void GeneralEllipse::position ( const unsigned &  t,
const Vector< double > &  xi,
Vector< double > &  r 
) const
inline

Definition at line 177 of file jeffery_orbit.cc.

Member Data Documentation

◆ A

double GeneralEllipse::A
private

Definition at line 154 of file jeffery_orbit.cc.

◆ B

double GeneralEllipse::B
private

Definition at line 154 of file jeffery_orbit.cc.

◆ Centre_x

double GeneralEllipse::Centre_x
private

Definition at line 154 of file jeffery_orbit.cc.

◆ Centre_y

double GeneralEllipse::Centre_y
private

Definition at line 154 of file jeffery_orbit.cc.

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