CSol
Namespaces | Classes | Typedefs | Functions | Variables
CSIRO::CSol Namespace Reference

Namespaces

 BF
 Bushfire solver.
 
 Boundary
 Boundary condition list.
 
 BoundaryLaplace
 Laplace boundary condition list.
 
 ColourScheme
 Colour scheme types.
 
 ComparisonOperation
 Comparison operations.
 
 CSol_PipeNetwork_from_Mesh_BadPipeDiameterHandling
 Shallow water boundary direction list.
 
 ESRIShapefileWriterShapeType
 Shapefile export
 
 FastMarching
 Fast marching method.
 
 Fill
 Return perfect hash of two signed integers.
 
 FillPosition
 Fill position list.
 
 GDALType
 GDAL data types.
 
 GridFace
 Grid face list.
 
 GridFileAccessOrder
 Grid File Access Order.
 
 GridOperation
 Grid operation list
 
 GridOperationScalar
 Grid scalar operation list
 
 GridOperationVector
 Grid operation list
 
 GridSlice
 Slice direction list.
 
 GridStatOperation
 Statistical operation type.
 
 InputType
 Input type for Grid edit widget.
 
 Interpolation
 Interpolation types.
 
 InterpolationHint
 Interpolation hint.
 
 Licensing
 
 MeshOperation
 Grid operation list
 
 OverlayPos
 Static overlay position for Grid view and edit widgets.
 
 PointOrLineData
 Point or line data.
 
 Potential_Type
 
 ProcPosition
 Identifier for where processor should be run within the solver timestep.
 
 Proj
 
 RainfallTimeSeriesDataType
 
 SeriesInterpolation
 Series interpolation type.
 
 SeriesOperationScalar
 Grid scalar operation list
 
 SiteType
 Pipe network node types.
 
 SiteVariables
 Pipe network node variables.
 
 SW
 Shallow water solver.
 
 SWBoundary
 Shallow water boundary types.
 
 Ui
 
 ViewType
 View type for Grid view and edit widgets.
 
 WaveBehaviour
 Shallow water boundary behaviour list.
 
 WaveDirection
 Shallow water boundary direction list.
 

Classes

class  AdaptorGridIntToReal
 A TypeAdaptor class for converting from a integer to real Grid. More...
 
class  AdaptorGridRealToInt
 A TypeAdaptor class for converting from a double to integer Grid. More...
 
class  BF_Fire_Tile
 
class  BF_Potential_Ranges
 Potential processor ranges. More...
 
class  BF_Potential_Tile
 Potential processor tile. More...
 
class  BF_Tile
 Bushfire computational tile. More...
 
class  BF_User_Temporal
 Bushfire user data layer for temporally varying data. More...
 
class  BF_Wind_Ranges
 Wind correction processor ranges. More...
 
class  BF_Wind_Tile
 Wind correction processor tile. More...
 
class  Config_BF
 Configuration for bushfire solver. More...
 
class  Config_SPH
 Configuration for shallow water solver. More...
 
class  Config_SW
 Configuration for shallow water solver. More...
 
class  CSol_2d_Ascii_to_Grid
 ESRI ascii reader. More...
 
class  CSol_2d_Ascii_to_Int_Grid
 Shallow water ascii reader. More...
 
class  CSol_2d_Fill_Grid
 Flood fill operation. More...
 
class  CSol_2d_Grid_Edit_Op
 Interactive 2D grid layer display with editing tools. More...
 
class  CSol_2d_Grid_Histo
 Histogram operation. More...
 
class  CSol_2d_Grid_Painting
 This takes in a grid and draws points or lines over the top of it outputs the modified grid. More...
 
class  CSol_2d_Grid_Sweep_Profile
 Put a one-line description of your operation here. More...
 
class  CSol_2d_Grid_to_Array
 Splits a grid into equally sized sub-grids stored in an array. More...
 
class  CSol_2d_Grid_to_Ascii
 ESRI ascii writer. More...
 
class  CSol_2d_Grid_to_Image
 Grid to QImage convertor. More...
 
class  CSol_2d_Grid_to_Mesh
 Grid to Mesh convertor. More...
 
class  CSol_2d_Grid_View
 2D layer for viewer. More...
 
class  CSol_2d_Grid_View_Op
 2D layer viewer. More...
 
class  CSol_2d_Grid_View_Overlay
 2D overlay for viewer. More...
 
class  CSol_2d_Grid_View_Widget
 Qt widget for viewer and editor. More...
 
class  CSol_2d_Grid_View_WidgetConnector
 Grid viewer connector class for Workspace. More...
 
class  CSol_2d_Grid_View_WidgetDesigner
 Qt Designer support for a widget. More...
 
class  CSol_2d_Grid_View_WidgetFactory
 Grid viewer factory for Workspace. More...
 
class  CSol_2d_Grids_to_Image
 Grid to QImage convertor. More...
 
class  CSol_2d_Grids_to_RGBA
 Shallow water image writer. More...
 
class  CSol_2d_Image_to_Grid
 Qimage to Grid convertor Converts a QImage to a 2D grid layer. More...
 
class  CSol_2d_Image_to_TileSet
 Converts a QImage into a set of RGBA Grid tiles. More...
 
class  CSol_2d_Mesh_View
 2D mesh for viewer. More...
 
class  CSol_3d_Field_to_Mesh
 Converts a set of one, two or three scalar components arranged in a 3D Grid to a vector field MeshModel. More...
 
class  CSol_Array3d_to_Grid
 Extracts part of an Array3d dataset and converts it into a CSol::Grid object. More...
 
class  CSol_ArrayNd_to_Grid
 Extracts part of an ArrayNd dataset and converts it into a CSol Grid object. More...
 
class  CSol_BF
 Bushfire spread solver. More...
 
class  CSol_BF_Proc
 Bushfire processor. More...
 
class  CSol_BF_Proc_Potential
 Potential timeseries processor implementation. More...
 
class  CSol_BF_Proc_Potential_Op
 Potential timeseries processor for bushfire operation. More...
 
class  CSol_BF_Proc_Spot
 Spotfire generator implementation. More...
 
class  CSol_BF_Proc_Spot_Op
 Spotfire generator processor for bushfire operation. More...
 
class  CSol_BF_Proc_Vector
 Vector crossing processor implementation. More...
 
class  CSol_BF_Proc_Vector_Op
 Vector crossing processor for bushfire solver. More...
 
class  CSol_BF_Proc_Wind_Correct
 Wind diagnostic correction implementation. More...
 
class  CSol_BF_Proc_Wind_Correct_Op
 Wind diagnostic correction processor for bushfire operation. More...
 
class  CSol_BF_Proc_Wind_Field
 Wind gridded processor implementation. More...
 
class  CSol_BF_Proc_Wind_Field_Op
 Wind gridded processor for bushfire operation. More...
 
class  CSol_BF_Proc_Wind_TimeSeries
 Wind timeseries processor implementation. More...
 
class  CSol_BF_Proc_Wind_TimeSeries_Op
 Wind timeseries processor for bushfire operation. More...
 
class  CSol_Binary_to_Grid
 Reads a CSol Grid binary file. More...
 
class  CSol_Colour
 Colour scheme. More...
 
class  CSol_Const_TimeSeries
 Creates a constant time series. More...
 
class  CSol_CSV_to_Grid
 Shallow water ascii reader. More...
 
class  CSol_CSV_to_TimeSeries
 Creates a time series from a CSV file. More...
 
class  CSol_ESRIShapefile
 ESRI Shapefile container. More...
 
class  CSol_ESRIShapefilePolygons2GridMask
 Converts a shapefile input to a raster Grid layer. More...
 
class  CSol_ESRIShapefilePolygonsGridOverlay
 Takes in an existing grid. More...
 
class  CSol_ESRIShapefileReader
 File reader for the ESRI Shapefile. More...
 
class  CSol_ESRIShapefileWriter
 File writer for the ESRI Shapefile. More...
 
class  CSol_GDALDatasetHandle_to_Grid
 Converts GDAL dataset into multi-dimensional Grid. More...
 
class  CSol_GeoSphere
 Put a one-line description of your operation here. More...
 
class  CSol_Grid_Composite
 Composites multiple Grids into a single Grid. More...
 
class  CSol_Grid_Create
 Grid creator. More...
 
class  CSol_Grid_Info
 Returns information about a Grid. More...
 
class  CSol_Grid_Op
 Carries out a range of operations on Grids, returning a new Grid. More...
 
class  CSol_Grid_Op_Scalar
 Carries out a range of operations on a Grid, returning a scalar value. More...
 
class  CSol_Grid_Op_Vector
 Carries out a range of operations on vectors and Grids, returning a new Grid. More...
 
class  CSol_Grid_Slice
 Extracts a two-dimensional slice from a three-dimensional Grid. More...
 
class  CSol_Grid_Stat
 Calculates running statistical operations on Grids. More...
 
class  CSol_Grid_Threshold
 Creates a thresholded grid from an input Grid. More...
 
class  CSol_Grid_to_Array3d
 Converts a three-dimensional Grid to a Workspace scalar array. More...
 
class  CSol_Grid_to_ArrayNd
 Creates an ArrayNd from a CSol::Grid. More...
 
class  CSol_Grid_to_Binary
 Writes a CSol Grid binary file. More...
 
class  CSol_Grid_to_CSV
 Shallow water ascii writer. More...
 
class  CSol_Grid_to_GDALWriter
 Writes a Grid to a file using GDAL. More...
 
class  CSol_Grid_to_GeoBoundingBox
 Returns a geospatial bounding box from a Grid. More...
 
class  CSol_Grid_Value
 Extracts a value from a CSol Grid. More...
 
class  CSol_Grid_Value_Line
 Extracts values from a CSol Grid along a set of line segments. More...
 
class  CSol_GridScalar_Info
 CSol_GridScalar_Info. More...
 
class  CSol_GridScalar_Info_Connector
 
class  CSol_GridScalar_Info_Factory
 
class  CSol_Image_to_GDALWriter
 Writes a QImage to a GeoTIFF using GDAL. More...
 
class  CSol_JsEdit
 CSolJeEdit script. More...
 
class  CSol_JsEdit_WidgetDesigner
 Qt Designer support for a widget. More...
 
class  CSol_Linear_TimeSeries
 Creates a linear time series. More...
 
class  CSol_LineEdit
 A line edit that registers keywords with the CSolKeywords class for syntax highlighting. More...
 
class  CSol_Mesh_Op
 
class  CSol_PipeNetwork
 Pipe network solver. More...
 
class  CSol_PipeNetwork_from_Mesh
 Converts MeshModelInterface pits and pipes into the Pipe Network data structure. More...
 
class  CSol_PipeNetwork_Load
 Load an xml pipe network file. More...
 
class  CSol_PipeNetwork_to_Mesh
 Converts a pipe network to a set of mesh models. More...
 
class  CSol_PipeNetwork_Write
 Load an xml pipe network file. More...
 
class  CSol_PN_Data_Extract
 Extracts data from a pipe network. More...
 
class  CSol_PN_Node_Extract_Value
 Pipe network extraction object. More...
 
class  CSol_PN_Node_Modification
 Pipe network modification object. More...
 
class  CSol_PN_to_Grid
 Creates a grid based on pipe network site locations. More...
 
class  CSol_Points_to_Grid
 Ascii points reader. More...
 
class  CSol_Proj
 Converts two-dimensional Grid layers between different geospatial projections. More...
 
class  CSol_QStringList_to_TimeSeries
 Creates a time series from a vector of times and values. More...
 
class  CSol_QVector_to_TimeSeries
 Creates a time series from a vector of times and values. More...
 
class  CSol_Series_Op_Scalar
 Carries out a range of operations on a Series, returning a scalar value. More...
 
class  CSol_SmoothedParticle
 
class  CSol_Solver
 CSol solver base class. More...
 
class  CSol_SW
 Shallow water solver. More...
 
class  CSol_SW_Ascii_to_Grid
 Shallow water ascii reader. More...
 
class  CSol_SW_GaugeData
 Put a one-line description of your datatype here. More...
 
class  CSol_SW_GaugeDataAccumulator
 Put a one-line description of your operation here. More...
 
class  CSol_SW_GaugeDataArrayReader
 Put a one-line description of your operation here. More...
 
class  CSol_SW_GaugeDataArrayWriter
 Put a one-line description of your operation here. More...
 
class  CSol_SW_GaugeLocationsFromDataSeries
 Put a one-line description of your operation here. More...
 
class  CSol_SW_GaugeLocationsFromMesh
 Put a one-line description of your operation here. More...
 
class  CSol_SW_Grid_to_Ascii
 Shallow water ascii writer. More...
 
class  CSol_SW_Grid_to_Image
 Shallow water image writer. More...
 
class  CSol_SW_Grid_to_Mesh
 Shallow water ascii writer. More...
 
class  CSol_SW_LB
 Shallow water solver. More...
 
class  CSol_SW_LB_Proc
 
class  CSol_SW_LB_Proc_WaveGen
 
class  CSol_SW_LB_Proc_WaveGen_Op
 Configuration for shallow water processor. More...
 
class  CSol_SW_Proc
 Shallow water processor. More...
 
class  CSol_SW_Proc_Evapotranspiration
 Shallow water evapotranspiration implementation. More...
 
class  CSol_SW_Proc_Evapotranspiration_Op
 Shallow water evapotranspiration processor. More...
 
class  CSol_SW_Proc_Infiltration
 Shallow water infiltration implementation. More...
 
class  CSol_SW_Proc_Infiltration_Op
 Shallow water infiltration processor. More...
 
class  CSol_SW_Proc_Inflow
 Shallow water inflow implementation. More...
 
class  CSol_SW_Proc_Inflow_Op
 Shallow water inflow processor. More...
 
class  CSol_SW_Proc_Line_Inflow
 Shallow water line inflow implementation. More...
 
class  CSol_SW_Proc_Line_Inflow_Op
 Shallow water line inflow processor. More...
 
class  CSol_SW_Proc_PipeNetwork
 Pipe network processor implementation. More...
 
class  CSol_SW_Proc_PipeNetwork_Op
 Pipe network processor for shallow water solver. More...
 
class  CSol_SW_Proc_Runoff
 Shallow water runoff implementation. More...
 
class  CSol_SW_Proc_Runoff_Op
 Shallow water runoff processor. More...
 
class  CSol_SW_Proc_Source
 Shallow water source implementation. More...
 
class  CSol_SW_Proc_Source_Op
 Shallow water source processor. More...
 
class  CSol_SW_Proc_Transport
 Shallow water advection-diffusion implementation. More...
 
class  CSol_SW_Proc_Transport_Op
 Shallow water advection-diffusion processor. More...
 
class  CSol_SW_Proc_Vector
 Vector crossing processor implementation. More...
 
class  CSol_SW_Proc_Vector_Op
 Vector crossing processor for shallow water solver. More...
 
class  CSol_SW_Proc_WaveGen
 Shallow water boundary processor implementation. More...
 
class  CSol_SW_Proc_WaveGen_Op
 Shallow water boundary processor. More...
 
class  CSol_TimeSeries_Edit_Op
 Operation for interactive editing of a timeseries. More...
 
class  CSol_TimeSeries_Tri
 Converts a set of time series at given positions to a triangulation. More...
 
class  CSol_Version
 Outputs CSol version number. More...
 
class  CSol_XYZ_to_Grid
 Ascii xyz reader. More...
 
class  CSolJsEditConnector
 
class  CSolJsEditFactory
 
class  CSolKeywords
 
class  CSolLineEditConnector
 
class  CSolLineEditFactory
 
class  CSolPlugin
 Computational solver. More...
 
class  CSolPluginDesigner
 WorkspacePlugin singleton class for this module. More...
 
class  DeltaGrid
 Delta map class for one or two dimensional data. More...
 
class  GLWidget
 OpenGL Widget class. More...
 
class  Grid
 Grid class for one, two or three dimensional data. More...
 
class  Grid2dTransform
 Two-dimensional grid transform class. More...
 
class  Lattice
 Lattice Boltzmann class. More...
 
class  Layer
 Layer structure Grid view and edit widgets. More...
 
class  LayerInfo
 Layer information class for Grid view and edit widgets. More...
 
class  Legend
 Legend class for Grid and mesh views. More...
 
class  LinearAlgebra
 OpenCL linear algebra class. More...
 
class  Matrix
 OpenCL linear algebra matrix class. More...
 
class  MeshInfo
 Mesh information class for Grid view and edit widgets. More...
 
class  Overlay
 Overlay class for Grid view and edit widgets. More...
 
class  Pipe
 Pipe network pipe (or connection) class. More...
 
class  PipeNetwork
 
class  PipeNetwork_Outlet
 Pipe network processor class for outlet information. More...
 
class  PlotBuildSeries
 Series builder. More...
 
class  PointSources_BF
 Configuration for bushfire solver point sources. More...
 
class  Series
 Series implementation. More...
 
class  Site
 Pipe network site (or junction) class. More...
 
class  SmoothedParticle
 
class  SparseMatrix
 OpenCL linear algebra sparse matrix class. More...
 
class  Tile
 Rendering tile class for Grid view and edit widgets. More...
 
class  TileSet
 
class  TimeSeries
 TimeSeries implementation. More...
 
class  TimeSeries_Display
 Display widget for time series. More...
 
class  TimeSeries_Edit_Widget
 Time series edit widget. More...
 
class  TimeSeries_Edit_WidgetDesigner
 Qt Designer support for a widget. More...
 
class  TimeSeries_View_Widget
 Viewer widget for time series. More...
 
class  TimeSeries_View_WidgetConnector
 
class  TimeSeries_View_WidgetDesigner
 Qt Designer support for a widget. More...
 
class  TimeSeries_View_WidgetFactory
 
class  Tri
 Interpolated triangular shape function implementation. More...
 
class  User_BF
 Bushfire user data layer. More...
 
class  Variable_BF
 Bushfire user variable. More...
 
class  Vector
 OpenCL linear algebra vector class. More...
 

Typedefs

typedef DeltaGrid< int > DeltaGridInt
 
typedef DeltaGrid< REAL > DeltaGridScalar
 
typedef DeltaGrid< unsigned int > DeltaGridUnsignedInt
 
typedef DeltaGrid< quint16 > DeltaGridUnsignedShort
 
typedef Grid< int > GridInt
 
typedef Grid< LatticeGridLattice
 
typedef Grid< REAL > GridScalar
 
typedef Grid< unsigned int > GridUnsignedInt
 
typedef Grid< quint16 > GridUnsignedShort
 
typedef unsigned int RGBA
 
typedef Tri< REAL > TriScalar
 Interpolated triangular scalar. More...
 
typedef Tri< CSIRO::CSol::TimeSeriesTriTimeSeries
 Interpolated triangular timeseries. More...
 

Functions

bool checkClockwiseWinding (const QVector< CSIRO::Mesh::Vector3d > &vectorPoints)
 
bool checkSwitchedSides (const CSIRO::Mesh::Vector3d &p0, const CSIRO::Mesh::Vector3d &p1, const double x0, const double x1, const double y)
 
bool checkThreshold (int thresholdType, double value, double thresholdValue)
 
REAL Covariance (GridScalar &, GridScalar &)
 Covariance. More...
 
REAL Dot (GridScalar &, GridScalar &)
 Dot product. More...
 
REAL Max (GridScalar &)
 Maximum value. More...
 
REAL Min (GridScalar &a)
 
std::ostream & operator<< (std::ostream &, const Grid2dTransform &)
 Output streaming operator for grid transform. More...
 
std::ostream & operator<< (std::ostream &, const DeltaGrid< REAL > &)
 Output streaming operator for grid delta map. More...
 
std::istream & operator>> (std::istream &, Grid2dTransform &)
 Input streaming operator for grid transform. More...
 
std::istream & operator>> (std::istream &, DeltaGrid< REAL > &)
 Input streaming operator for grid delta map. More...
 
bool paintPolygon (CSIRO::CSol::GridScalar &grid, CSIRO::CSol::GridScalar &gridBuffer, const QVector< CSIRO::Mesh::Vector3d > &vectorPoints, const double xmin, const double xmax, const double ymin, const double ymax, const double inValue)
 
double round (double d)
 
bool SeriesLessThan (const QPair< double, double > &s0, const QPair< double, double > &s1)
 Series less than operator. More...
 

Variables

const double defaultHeightMin = 1.0E-3
 
const REAL dt_start = (REAL)1.0E-6
 
const int gridVersion = 3
 Grid binary version. More...
 
const REAL hmin = (REAL)1.0E-6
 
const int noDataInt = -32768
 Default no-data integer values. More...
 
const REAL noDataReal = -FLT_MAX
 Default no-data floating-point values. More...
 

Typedef Documentation

typedef DeltaGrid<int> DeltaGridInt
typedef DeltaGrid<REAL> DeltaGridScalar
typedef DeltaGrid<unsigned int> DeltaGridUnsignedInt
typedef Grid<int> GridInt
typedef Grid<REAL> GridScalar
typedef Grid<unsigned int> GridUnsignedInt
typedef Grid<quint16> GridUnsignedShort
typedef unsigned int RGBA
typedef Tri<REAL> TriScalar

Function Documentation

bool checkClockwiseWinding ( const QVector< CSIRO::Mesh::Vector3d > &  vectorPoints)
bool checkSwitchedSides ( const CSIRO::Mesh::Vector3d &  p0,
const CSIRO::Mesh::Vector3d &  p1,
const double  x0,
const double  x1,
const double  y 
)
bool CSIRO::CSol::checkThreshold ( int  thresholdType,
double  value,
double  thresholdValue 
)
REAL CSIRO_IMPORTSPEC Covariance ( GridScalar ,
GridScalar  
)
Returns
Covariance of two grids.

Returns covariance of two grids

REAL CSIRO_IMPORTSPEC Dot ( GridScalar ,
GridScalar  
)
Returns
Sum of products of two grids.

Returns dot product of two grids

REAL CSIRO_IMPORTSPEC Max ( GridScalar )

Minimum value.

Returns
Maximum value over Grid.
Minimum value over Grid.

Returns maximum value of grid

REAL CSIRO::CSol::Min ( GridScalar a)

Returns maximum value of grid

std::ostream & operator<< ( std::ostream &  os,
const Grid2dTransform transform 
)
std::ostream & operator<< ( std::ostream &  os,
const DeltaGrid< REAL > &  delta 
)
std::istream & operator>> ( std::istream &  is,
Grid2dTransform transform 
)
std::istream & operator>> ( std::istream &  is,
DeltaGrid< REAL > &  delta 
)
bool paintPolygon ( CSIRO::CSol::GridScalar grid,
CSIRO::CSol::GridScalar gridBuffer,
const QVector< CSIRO::Mesh::Vector3d > &  vectorPoints,
const double  xmin,
const double  xmax,
const double  ymin,
const double  ymax,
const double  inValue 
)
double CSIRO::CSol::round ( double  d)
bool CSIRO::CSol::SeriesLessThan ( const QPair< double, double > &  s0,
const QPair< double, double > &  s1 
)

Variable Documentation

const double defaultHeightMin = 1.0E-3
const REAL dt_start = (REAL)1.0E-6
const int gridVersion = 3
const REAL hmin = (REAL)1.0E-6
const int noDataInt = -32768
const REAL noDataReal = -FLT_MAX