com1DFA.com1DFA¶

Main functions for python DFA kernel

Functions

`DFAIterate`	Perform time loop for DFA simulation
`analysisPlots`	create analysis plots during simulation run
`appendFieldsParticles`	append fields and optionally particle dictionaries to list for export
`com1DFAMain`	Run main model
`computeEulerTimeStep`	compute next time step using an euler forward scheme
`computeLeapFrogTimeStep`	compute next time step using a Leap Frog scheme
`createReportDict`	create simulaton report dictionary
`exportFields`	export result fields to Outputs directory according to result parameters and time step that can be specified in the configuration file
`getSimTypeList`	Define available simulation types of requested types
`initializeMassEnt`	Initialize mass for entrainment
`initializeMesh`	Create rectangular mesh
`initializeParticles`	Initialize DFA simulation
`initializeResistance`	Initialize resistance matrix
`initializeSimulation`	create simulaton report dictionary
`placeParticles`	Create particles in given cell
`plotContours`
`plotPosition`
`polygon2Raster`	convert line to raster
`prepareArea`	convert shape file polygon to raster
`prepareInputData`	Fetch input data
`prepareRelase`	get Simulation to run for a given release
`prepareVarSimDict`	Prepare a dictionary with simulations that shall be run with varying parameters following the variation dict
`readPartFromPickle`	Read pickles within a directory and return List of dicionaries read from pickle
`releaseSecRelArea`	Release secondary release area if trigered
`reportAddTimeMassInfo`	Add time and mass info to report
`savePartToCsv`	Save each particle dictionary from a list to a csv file; works also for one dictionary instead of list
`savePartToPickle`	Save each dictionary from a list to a pickle in outDir; works also for one dictionary instead of list
`setDEMoriginToZero`	set origin of DEM to 0,0
`writeMBFile`	write mass balance info to file