sph/docs/IGravity_8h_source.html

 #pragma once


 #include "common/ForwardDecl.h"

 #include "objects/geometry/Vector.h"


 NAMESPACE_SPH_BEGIN


 class IGravity : public Polymorphic {

 public:

     virtual void build(IScheduler& scheduler, const Storage& storage) = 0;


     virtual void evalAll(IScheduler& scheduler, ArrayView<Vector> dv, Statistics& stats) const = 0;


     virtual Vector eval(const Vector& r0) const = 0;


     virtual Float evalEnergy(IScheduler& scheduler, Statistics& stats) const = 0;


     virtual RawPtr<const IBasicFinder> getFinder() const = 0;

 };


 NAMESPACE_SPH_END

NAMESPACE_SPH_BEGIN
NAMESPACE_SPH_BEGIN
Definition: BarnesHut.cpp:13

ForwardDecl.h

Float
double Float
Precision used withing the code. Use Float instead of float or double where precision is important.
Definition: Globals.h:13

NAMESPACE_SPH_END
#define NAMESPACE_SPH_END
Definition: Object.h:12

Vector.h
Basic vector algebra. Computations are accelerated using SIMD.

ArrayView
Object providing safe access to continuous memory of data.
Definition: ArrayView.h:17

BasicVector< Float >

IGravity
Interface for computing gravitational interactions of particles.
Definition: IGravity.h:14

IGravity::getFinder
virtual RawPtr< const IBasicFinder > getFinder() const =0
Optionally returns a finder used by the gravity implementation.

IGravity::build
virtual void build(IScheduler &scheduler, const Storage &storage)=0
Builds the accelerating structure.

IGravity::evalEnergy
virtual Float evalEnergy(IScheduler &scheduler, Statistics &stats) const =0
Computes the total potential energy of the particles.

IGravity::eval
virtual Vector eval(const Vector &r0) const =0
Evaluates the gravitational acceleration at given point.

IGravity::evalAll
virtual void evalAll(IScheduler &scheduler, ArrayView< Vector > dv, Statistics &stats) const =0
Evaluates the gravitational acceleration concurrently.

IScheduler
Interface that allows unified implementation of sequential and parallelized versions of algorithms.
Definition: Scheduler.h:27

RawPtr
Non-owning wrapper of pointer.
Definition: RawPtr.h:19

Statistics
Object holding various statistics about current run.
Definition: Statistics.h:22

Storage
Container storing all quantities used within the simulations.
Definition: Storage.h:230

Polymorphic
Base class for all polymorphic objects.
Definition: Object.h:88