feat: documentation

This commit is contained in:
robin
2024-04-29 17:38:29 +02:00
parent 37d0593f65
commit eb60e21d66
5 changed files with 41 additions and 1 deletions

View File

@@ -7,8 +7,19 @@
#define DT 50
/*
* Implement this class for every integration method.
*/
class AdvectionKernel {
public:
/**
* This function must take a time, latitude and longitude of a particle and must output
* a new latitude and longitude after being advected once for DT time as defined above.
* @param time Time since the beginning of the data
* @param latitude Latitude of particle
* @param longitude Longitude of particle
* @return A pair of latitude and longitude of particle.
*/
virtual std::pair<double, double> advect(int time, double latitude, double longitude) const = 0;
};