TO_DO_LIST.md

TO DO LIST

089 is max (also using github permalinks to code lines)

Table of contents

• [Documentation]{#documentation)
• User input
• Error handling
• Theory/Efficiency
• Output
• Completed

Documentation

• TODO 001 [Add more information about all classes]
• TODO 007 [Need more info re. setup and surge from Manuel]

User input

• TODO 000 [Should user input be split in two main files]
• TODO 011 Should this constant be a user input? 1 2 3
• TODO 036 Read in changed deep water wave values
• TODO 030 [Do we also need to be able to input landform sub-categories?] code
• TODO 027 Sort out GDAL problem with raster reference units
• TODO 022 Get intervention update working
• TODO 042 [Should we have a smallest valid input for KLS in the CERC equation?] code
• TODO 045 [Method of getting depth of closure value needs to be a user input] code
• TODO 049 Handle other command line parameters e.g. path to .ini file, path to datafile
• TODO 035 Also handle other EPSG for vector spatial reference systems
• TODO 054 [Choose more files to omit from "usual" raster output]
• TODO 069 [Enable ability to represent intervention structures which have their foundation embedded in consolidated sediment. In other words, with the elevation of the base of the intervention structure below the top of all consolidated sediment layers. Will need some sanity checking of elevations]
• TODO 071 [If the user input file format is changed, write a Python script to convert from the old file format to the new]
• TODO 083 [Get all three kinds of sediment input events working correctly]

Error handling

• TODO 038 [Do better error handling if insufficient memory]
• TODO 004 Improve error handling of situation where we have a valid shadow zone but cannot find a neighbouring cell which is 'under' the coastline
• TODO 006 Check GDALGridCreate() with only start-of-coast or an end-of-coast profiles
• TODO 009 Decide what to do when we have eroded down to basement
• TODO 017 Extra safety check needed, make sure that each point is within valid grid
• TODO 018 Improve situation where new landwards point on parallel profile is not within the raster grid 2
• TODO 019 Improve situation where Dean profile has a near-zero elevation difference 2
• TODO 020 Check calculation of elevation of coast point of Dean parallel profile 2
• TODO 021 Improve situation where all layers have zero thickness
• TODO 025 Improve situation where this point has only zero thickness layers 2
• TODO 026 Check situation where cell in parallel profile is not in a polygon
• TODO 028 Give a warning if raster input layer has several bands
• TODO 038 Do better error handling if insufficient memory
• TODO 053 Improve handling of situation where landward elevation of profile is -ve
• TODO 055 [Maybe add a safety check?]
• TODO 080 [Do we get -ve breaking wave heights here?]
• TODO 084 [Improve handling of situation where consecutive profile points are same distance from shoreline]

Theory/Efficiency

• TODO 002 Do we really need D50 for drift landform class? What do we need for drift?
• TODO 005 Maybe give every coast point a value for end-of-profile wave height and direction instead of for deep water wave height and direction
• TODO 010 Do we also need to update the active zone cells?
• TODO 012 Change finding of adjacent polygons, and calculation of the length of shared normals, when we make polygon seaward length determined by depth of closure
• TODO 013 Change calculation (need user input?) of coastline smoothing convexity threshold
• TODO 014 Profile spacing, vould try gradually increasing the profile spacing with increasing concavity, and decreasing the profile spacing with increasing convexity
• TODO 016 Check mass balance for recirculating unconsolidated sediment option
• TODO 023 Only calculate shore platform erosion if cell is in a polygon
• TODO 024 Should we calculate platform erosion on a profile that has hit dry land?
• TODO 044 Implement estuaries. Before we can do this, we will need to deal with multiple coastlines. Will need to get working where profile hits another profile which belongs to a different coast object. 2
• TODO 037 Need more info on nFindIndex
• TODO 051 Implement other ways of calculating depth of closure, see TODO 045
• TODO 056 [Check this please Andres]
• TODO 059 [Implement dune landform class]
• TODO 060 [Remove 'magic numbers' from code here]
• TODO 061 [Is this safety check to depth of breaking a reasonable thing to do?]
• TODO 066 [Should this be for all layers? Check]
• TODO 067 [Is this ever non-zero? Check]
• TODO 070 [Change CShore to use allocatable arrays (https://fortran-lang.org/en/learn/best_practices/allocatable_arrays/) so that the number of points in the CShore output profiles can either be a user input, or determined by e.g. the physical length of the profile]
• TODO 075 [What if bedrock protrudes above Dean profile?]
• TODO 076 [When doing parallel profiles, start from the profile which is closest to a right angle with the coast]
• TODO 077 [As traverse between the bounding profiles creating parallel profiles, gradually change the parallel profile orientation based on distance weighting of two bounding profiles]
• TODO 078 [At present, we don't allow cliff collapse onto interventions. Is this realistic? Should it change with different types of intervention?]
• TODO 089 [Why do we get patches of sediment in the sea?] TODO 086 [Try alternatives to GDALGridCreate(), e.g. https://gts.sourceforge.net/index.html, https://doc.cgal.org/latest/Triangulation_2/index.html#Chapter_2D_Triangulations] TODO 088 [In (almost) all whole-grid loops, immediately continue if cell is hinterland (but not when calculating cliff collapse)]

Output

• TODO 065 [Get GPKG output working]
• TODO 063 [Add NetCDF support, see https://trac.osgeo.org/gdal/wiki/NetCDF]
• TODO 064 [Add support for grids that are not oriented N-S and W-E, but are still rectangular (will need to add a transformation in the reading and writing process, the first to bring it to the local base and the second to save it in global coordinates)]
• TODO 031 Get raster slice output working with multiple slices
• TODO 032 Improve output scaling for DBL_NODATA situation
• TODO 033 Also test and configure (e.g. by passing open() options) other vector output file formats
• TODO 034 Also test and configure (e.g. by passing open() options) other raster output file formats
• TODO 043 [When outputting profiles, how do we deal with randomness of profile spacing (since profile location is determined by curvature)?]
• TODO 052 [Improve saving of profiles and parallel profiles]
• TODO 062 [Show end-of-iteration number of cells with sediment somewhere]
• TODO 068 [Only show output in log file that is relevant to processes being simulated]
• TODO 074 [Output history of what landforms are on a particular cell or cells. User inputs cell(s), how?]
• TODO 082 [Also show m_dStartIterUnconsFineAllCells etc. in log file]

Completed

• TODO 003 [Make coastline curvature moving window size a user input DONE in 1.1.22]
• TODO 046 [Why is cliff collapse eroded during deposition (three size classes) no longer calculated? DONE IN 1.1.22]
• TODO 058 [Dave to check this DONE in 1.1.22]
• TODO 039 [Rewrite reading of multiple random number seeds DONE in 1.2.1, 8 Nov 2024]
• TODO 041 [Read in SWL per-timestep]
• BUG 002 [Useless output e.g. clay layers even if no clay input DONE in 1.1.21]
• BUG 003 [Use mean SWL for elevations of Dean profiles DONE in 1.2.1, 27 Nov 2024]
• BUG 004 [Don't smooth intervention coastline DONE 1.2.1, 27 Nov 2024]
• TODO 073 [If output dir does not exist, then create it (ask user first) DONE 1.2.2, 28 Nov 2024]
• TODO 047 [Where is the GDAL description for the deep water wave stations vector file? DONE 1.2.3, 2 Dec 2024]
• TODO 048 [Where is the GDAL description for the flood input locations point or vector file? DONE 1.2.3, 2 Dec 2024]
• TODO 027 [Sort out GDAL problem with raster reference units DONE 1.2.3, 2 Dec 2024]
• TODO 079 [Do sanity checking on wave and tide input DONE 1.2.3, 2 Dec 2024]
• TODO 072 [CShore crashes occasionally, is it because of -ve Z values here? DONE 1.2.3, 2 Dec 2024]
• TODO 050 [Update for recent versions of Windows DONE 1.2.3, 2 Dec 2024]
• TODO 037 [Need more info on nFindIndex() DONE 1.2.3, 2 Dec 2024]
• [Improve coast normals DONE 1.2.3, 20 Dec 2024]
• TODO 057 [Check this please Manuel DONE 1.2.4, 4 Jan 2025]
• TODO 087 [Is there a problem if profile is not long enough for user-input depth of closure? DONE 1.3.0 2 Feb 2025]