Particle Class Reference

#include <Particle.h>

Collaboration diagram for Particle:

Public Member Functions
	Particle ()
	It creates a new empty particle.
	Particle (CotangentBundlePoint qp, double rho, double e, double P, double m, double h, int preSteps)
	It creates a new particle with the parameters supplied.
CotangentBundlePoint	getCotangentBundlePoint ()
	It retrieves the cotangent bundle point of the particle.
CotangentBundlePoint	getCotangentBundlePoint (int i)
	It retrieves the cotangent bundle point of the particle i steps before.
double	getDensity ()
	It retrieves the energy of the particle.
double	getDensity (int i)
	It retrieves the energy of the particle i steps before.
double	getEnergy ()
	It retrieves the energy of the particle.
double	getEnergy (int i)
	It retrieves the energy of the particle i steps before.
double	getPressure ()
	It retrieves the pressure of the particle.
double	getPressure (int i)
	It retrieves the pressure of the particle i steps before.
double	getRestMass ()
	It retrieves the rest mass of the particle.
double	getSmoothingLength ()
	It retrieves the smoothing length of the particle.
void	setCotangentBundlePoint (CotangentBundlePoint qp)
	It changes the cotangent bundle point of the particle.
void	setDensity (double rho)
	It changes the density of the particle.
void	setEnergy (double e)
	It changes the energy of the particle.
void	setPressure (double P)
	It changes the pressure of the particle.
void	setRestMass (double m)
	It changes the rest mass of the particle.
void	setSmoothingLength (double h)
	It changes the smoothing length of the particle.
	~Particle ()
	It destroys the object Particle.

Constructor & Destructor Documentation

Particle::Particle

(

)

It creates a new empty particle.

Particle::Particle	(	CotangentBundlePoint	qp,
		double	rho,
		double	e,
		double	P,
		double	m,
		double	h,
		int	preSteps
	)

It creates a new particle with the parameters supplied.

Parameters

qp	cotangent bundle point
rho	density of the particle
e	energy of the particle
P	pressure of the particle
m	rest mass of the particle
h	smoothing length of the particle
preSteps	number of previous steps stored

Particle::~Particle

(

)

It destroys the object Particle.

Member Function Documentation

CotangentBundlePoint Particle::getCotangentBundlePoint

(

)

It retrieves the cotangent bundle point of the particle.

Returns

an object containing the cotangent bundle point of the particle

Here is the caller graph for this function:

CotangentBundlePoint Particle::getCotangentBundlePoint

(

int

i

)

It retrieves the cotangent bundle point of the particle i steps before.

Returns

an object containing the cotangent bundle point of the particle i steps before

double Particle::getDensity

(

)

It retrieves the energy of the particle.

Returns

the density of the particle

double Particle::getDensity

(

int

i

)

It retrieves the energy of the particle i steps before.

Returns

the density of the particle i steps before

double Particle::getEnergy

(

)

It retrieves the energy of the particle.

Returns

the energy of the particle

double Particle::getEnergy

(

int

i

)

It retrieves the energy of the particle i steps before.

Returns

the energy of the particle i steps before

double Particle::getPressure

(

)

It retrieves the pressure of the particle.

Returns

the pressure of the particle

double Particle::getPressure

(

int

i

)

It retrieves the pressure of the particle i steps before.

Returns

the pressure of the particle i steps before

double Particle::getRestMass

(

)

It retrieves the rest mass of the particle.

Returns

the rest mass of the particle

double Particle::getSmoothingLength

(

)

It retrieves the smoothing length of the particle.

Returns

the smoothing length of the particle

void Particle::setCotangentBundlePoint

(

CotangentBundlePoint

qp

)

It changes the cotangent bundle point of the particle.

Parameters

cotangentBundlePoint

the new the cotangent bundle point of the value

void Particle::setDensity

(

double

rho

)

It changes the density of the particle.

Parameters

rho	the new density value

void Particle::setEnergy

(

double

e

)

It changes the energy of the particle.

Parameters

e	the new energy value

void Particle::setPressure

(

double

P

)

It changes the pressure of the particle.

Parameters

P	the new pressure value

void Particle::setRestMass

(

double

m

)

It changes the rest mass of the particle.

Parameters

m	the new rest mass value

void Particle::setSmoothingLength

(

double

h

)

It changes the smoothing length of the particle.

Parameters

h	the new smoothing length value

---

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

• Particle.h
• Particle.cpp