do_beach_sediment_movement.cpp File Reference

Does between-polygon actual (supply-limited) redistribution of transported beach sediment. More...

#include <assert.h>
#include <cmath>
#include <cfloat>
#include <iostream>
#include <string>
#include <algorithm>
#include "cme.h"
#include "simulation.h"
#include "coast.h"

Go to the source code of this file.

Functions
bool	bPolygonAndAdjCompare (const vector< int > &nVLeft, const vector< int > &nVRight)
	Function used to sort polygons before doing the polygon-to-polygon source-target pattern. For both LH and RH arguments, the first element is the polygon global, the second element is the polygo coast ID, the third element is the down- or up-coast direction, and fourth and subsequent elements are adjacent polygon coast IDs in that direction. If the first argument must be ordered before the second (i.e. the original sequence is to be retained), return true. If the second argument must be ordered before the first (i.e. the arguments must be swapped), return false.

Detailed Description

Does between-polygon actual (supply-limited) redistribution of transported beach sediment.

TODO 001 A more detailed description of these routines.

Author

David Favis-Mortlock

Andres Payo

Date

2025

Copyright

GNU General Public License

Definition in file do_beach_sediment_movement.cpp.

Function Documentation

bPolygonAndAdjCompare()

bool bPolygonAndAdjCompare	(	const vector< int > &	nVLeft,
		const vector< int > &	nVRight )

Function used to sort polygons before doing the polygon-to-polygon source-target pattern. For both LH and RH arguments, the first element is the polygon global, the second element is the polygo coast ID, the third element is the down- or up-coast direction, and fourth and subsequent elements are adjacent polygon coast IDs in that direction. If the first argument must be ordered before the second (i.e. the original sequence is to be retained), return true. If the second argument must be ordered before the first (i.e. the arguments must be swapped), return false.

Definition at line 47 of file do_beach_sediment_movement.cpp.

Referenced by CSimulation::nDoAllActualBeachErosionAndDeposition().