GlobalDownwardsGravity Class Reference

Class to calculate the global downwards gravity force. More...

#include <GlobalDownwardsGravity.h>

Inheritance diagram for GlobalDownwardsGravity:

Collaboration diagram for GlobalDownwardsGravity:

Public Member Functions
	GlobalDownwardsGravity (double g)
	Constructor for the GlobalDownwardsGravity class. More...
std::array< double, 3UL >	calculateForce (Particle &p) const override
	Calculates the downwards gravity force on a particle using the given gravitational acceleration. More...
	operator std::string () const override
	Returns "Gravity" as name of the force. More...
void	setGravitationalAcceleration (double g)
	Sets the gravitational acceleration. More...
Public Member Functions inherited from SimpleForceSource
virtual	~SimpleForceSource ()=default
	Virtual destructor for correct cleanup of derived classes. More...

Private Attributes
double	g

Detailed Description

Class to calculate the global downwards gravity force.

Definition at line 8 of file GlobalDownwardsGravity.h.

Constructor & Destructor Documentation

GlobalDownwardsGravity()

GlobalDownwardsGravity::GlobalDownwardsGravity ( double  g )

explicit

Constructor for the GlobalDownwardsGravity class.

Parameters

g	Gravitational acceleration

Definition at line 3 of file GlobalDownwardsGravity.cpp.

: g(g) {}

Member Function Documentation

calculateForce()

std::array< double, 3UL > GlobalDownwardsGravity::calculateForce ( Particle &  p ) const

overridevirtual

Calculates the downwards gravity force on a particle using the given gravitational acceleration.

Parameters

p

Particle

Returns

std::array<double, 3UL> Force vector

Implements SimpleForceSource.

Definition at line 5 of file GlobalDownwardsGravity.cpp.

{ return {0.0, -p.getM() * g, 0.0}; }

operator std::string()

GlobalDownwardsGravity::operator std::string ( ) const

explicitoverridevirtual

Returns "Gravity" as name of the force.

Implements SimpleForceSource.

Definition at line 7 of file GlobalDownwardsGravity.cpp.

{ return "GlobalDownwardsGravity: g=" + std::to_string(g); }

setGravitationalAcceleration()

void GlobalDownwardsGravity::setGravitationalAcceleration

(

double

g

)

Sets the gravitational acceleration.

Parameters

g	Gravitational acceleration

Definition at line 9 of file GlobalDownwardsGravity.cpp.

{ this->g = g; }

Member Data Documentation

g

double GlobalDownwardsGravity::g

private

Definition at line 10 of file GlobalDownwardsGravity.h.

---

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

• GlobalDownwardsGravity.h
• GlobalDownwardsGravity.cpp