OGS 6.1.0-1402-g949b995be  949b995b
Source code documentation
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12345]
 NAdsorption
 Nanonymous_namespace{PythonBoundaryCondition.cpp}
 Nanonymous_namespace{PythonSourceTerm.cpp}
 Nanonymous_namespace{qrc_icons.cpp}
 NApplicationsLibThe LinearSolverLibrarySetup takes care of proper initialization and shutting down of an external linear solver library
 NApplicationUtils
 NAssemblerLibDocumentation of namespaces
 NBaseLibBuild information
 NDataHolderLib
 Ndetail
 NFileIOContains the interfaces for all file types that can be read and/or written using OpenGeoSys
 NGeoLibCopyright (c) 2012-2018, OpenGeoSys Community (http://www.opengeosys.org) Distributed under a Modified BSD License
 NMaterialLibCommon convenitions for naming: x_D - deviatoric part of tensor x x_V - volumetric part of tensor x x_p - a variable related to plastic potential x_prev - value of x in previous time step
 NMathLibContains all mathematical functionality used in OpenGeoSys, from defining a vector or calculating a norm to integration schemes and matrix preconditioners
 NMeshGeoToolsLibImplementation of heuristic search length strategy
 NMeshLibContains all functionality concerned with defining and obtaining information about meshes and their components (nodes, elements)
 NNumLibThe numerical algorithms used in OpenGeoSys
 NProcessLibCommon convenitions for naming: X_gas_nonwet mass fraction of gas component(e.g air) in nonwetting phase (gas component doesn't include water vapor, same for the following) x_gas_nonwet molar fraction of gas component in nonwetting phase x_vapor_nonwet molar fraction of vapor in nonwetting phase p_vapor_nonwet water vapor pressure p_gas_nonwet partial pressure of gas component mol_density_nonwet molar density of nonwetting phase mol_density_water molar density of water density_water mass density of water density_nonwet_gas mass density of gas component in the nonwetting phase density_nonwet_vapor mass density of vapor in the nonwetting phase density_nonwet mass density of the nonwetting phase density_wet mass density of wetting pahse density_solid mass density of the solid phase velocity_nonwet velocity of nonwetting phase velocity_wet velocity of wetting phase heat_capacity_dry_gas heat capacity of dry gas heat_capacity_water_vapor heat capacity of water vapor heat_capacity_water heat capacity of liquid water heat_capacity_solid heat capacity of soil grain latent_heat_evaporation latent heat for evaporation(water to vapor) enthalpy_nonwet_gas enthalpy of gas component in the nonwetting phase enthalpy_nonwet_vapor enthalpy of water vapor in the nonwetting phase enthalpy_wet enthalpy of wetting phase enthalpy_nonwet enthalpy of the nonwetting phase internal_energy_nonwet specific internal energy for the nonwetting phase internal_energy_wet specific internal energy for the wetting phase heat_conductivity_dry_solid heat conductivity of the dry porous medium heat_conductivity_wet_solid heat conductivity of the fully saturated porous medium heat_conductivity_unsaturated heat conductivity of the unsaturated porous medium
 CAddLayerToMeshDialogA dialog window for adding a layer to the top or bottom of a mesh
 CBaseItemA BaseItem contains additional Information about a subtree in the StationTreeModel
 CCheckboxDelegateCheckboxDelegate modifies a model view to display boolean values as checkboxes
 CColorPickerPushButtonColorPickerPushButton calls a QColorDialog on clicking and then sends a colorPicked(QColor) signal
 CColorTableModelThe PolylinesModel is a Qt model which represents Polylines
 CColorTableViewA QTableView to display colour lookup tables
 CColorTableViewDelegateA delegate class to manage properties of ColorTableView
 CCondFromRasterDialogA dialog window for creating DIRECT boundary conditions from raster files
 CCondItemA TreeItem containing a boundary condition or source term
 CCreateStructuredGridDialogA dialog window for managing general Data Explorer settings
 CDataExplorerSettingsDialogA dialog window for managing general Data Explorer settings
 CDetailWindowCreates a window containing a diagram
 CDiagramListA List of data points and all the necessary meta-information to draw a graph
 CDiagramPrefsDialogA dialog that allows for setting preferences for a requested diagram
 CDiagramSceneA scene graph for a 2D Diagram including coordinate axes with labels and ticks for one or more plotted graphs
 CDiagramViewA view in which to display a DiagramScene
 CDirectConditionGenerator
 CDoubleHelper struct used in conjunction with std::integer_sequence<int, ...> to get a sequence of types, where each type is double
 CEigenDynamicShapeMatrixPolicyAn implementation of ShapeMatrixPolicy using dynamic size eigen matrices and vectors
 CEigenFixedShapeMatrixPolicyAn implementation of ShapeMatrixPolicy using fixed size (compile-time) eigen matrices and vectors
 CElementErrorCodeCollects error flags for mesh elements
 CElementTreeModelA model for the display of information concerning element information implemented as a TreeModel
 CElementTreeViewA TreeView to display mesh element properties
 CFemConditionModelA model for the display of information from boundary conditions and source terms
 CFemConditionViewA TreeView to display information of FEM conditions
 CFileListDialogA list of selected files selected for conversion incl
 CGEOModelsGEOModels connects the data management class GEOObjects and the GUI
 CGEOModelsCallbacks
 CGeoObjectListItemCreates parent items for geometric object lists (i.e
 CGeoOnMeshMappingDialogA dialog window for creating DIRECT boundary conditions from raster files
 CGeoTabWidgetWidget containing GeoTreeView-objects
 CGeoTreeItemA TreeItem containing an additional GeoObject
 CGeoTreeModelA model for the GeoTreeView implementing a tree as a double-linked list
 CGeoTreeViewA view for the GeoTreeModel
 CGMSHPrefsDialogA dialog window for setting preferences for GMSH
 CImportFileTypeTypes of supported import file formats
 CLastSavedFileDirectory
 CLayeredMeshGeneratorBase class for creation of 3D subsurface meshes based on raster data
 CLayeredVolumeCreates a volume geometry from 2D mesh layers based on raster data
 CLicenseDialogA dialog window displaying the OGS license information
 CLinearEditDialogA dialog window for creating linear boundary conditions on polylines
 CLineEditDialogA dialog window for manipulation of polylines
 CMainWindowMain program window for the graphical user interface of OpenGeoSys
 CMergeGeometriesDialogA dialog window for setting preferences for GMSH
 CMeshAnalysisDialogA dialog window for calling mesh analysis methods
 CMeshElementRemovalDialogA dialog window for settung up a database connection
 CMeshFromRasterDialogA dialog for specifying the parameters to construct a mesh based on a raster
 CMeshLayerEditDialogA dialog window for editing meshes in various ways
 CMeshMapping2DDialogA dialog window for mapping a 2d mesh based on a raster file
 CMeshQualitySelectionDialogA dialog for selecting a mesh quality metric
 CMeshValueEditDialogA dialog window for changing the MaterialID for mesh elements
 CModellingTabWidgetWidget containing the ProcessView
 CModelTest
 CModelTreeItemA TreeItem containing some additional information used in the StationModel
 CMshEditDialogA dialog window for editing meshes in various ways
 CMshItemA TreeItem containing a mesh and the associated vtk object used in the Mesh Model
 CMshModelThe MshModel is a Qt model which represents Mesh objects
 CMshTabWidgetWidget for data views of meshes
 CMshViewThe DataView is table view which acts as a base class for displaying several OGS data formats
 CNetCdfConfigureDialogThe dialog for converting data from NetCDF-files into OGS data structures
 CnodeByCoordinatesComparator
 COGSErrorManages error messages via message boxes
 COGSFileConverterA conversion tool for ogs5 and ogs6 files
 COGSFilterInfoStores information about filters in VtkOGSFilter for access-routines from the GUI
 CProcessModelA model implementing a tree structure for process-relevant information such as process types, FEM-Conditions (BCs, ICs, STs), etc
 CProcessVarItemA TreeItem representing process variable information
 CProcessViewA view for FEM-Conditions (Initial- & Boundary Conditions / Source Terms) with a number of additional information such as Process Type, Distribution, etc
 CProjectDataThe ProjectData Object contains all the data needed for a certain project, i.e
 CQArrowAn arrow as a QGraphicsObject
 CQGraphicsGridA 2D carthesian grid as a QGraphicsItem
 CQNonScalableGraphicsTextItemA QGraphicsTextItem that will ignore all geometric transformations
 CQValueTooltipSliderA QSlider which shows its value as a tooltip when moved
 CQVtkDataSetMapperSimply wraps vtkDataSetMapper as a Qt object to enable slot connections
 CRecentFilesFunctionality to store informations about recently used files (e.g
 CSaveMeshDialogA dialog window for managing properties for writing meshes to files
 CSelectMeshDialogSmall dialog for setting a name for an object
 CSensorDataA container for sensor data at an observation site
 CSetNameDialogSmall dialog for setting a name for an object
 CSHPImportDialogDialog for selecting which information should be loaded from a shape file
 CStationTabWidgetWidget containing StationTreeView-objects
 CStationTreeModelA model for the StationTreeView implementing a tree as a double-linked list
 CStationTreeViewA view for the StationTreeModel
 CStratBarA 2D bar visualisation of a borehole stratigraphy
 CStratSceneThe scene for the visualisation of the stratigraphy of a borehole
 CStratViewA view in which to display the stratigraphy of a borehole
 CStratWindowCreates a window to visualise the stratigraphy of a borehole
 CStrictDoubleValidatorA validator for an input field which only accepts decimals
 CStrictIntValidatorA validator for an input field which only accepts integers
 CSurfaceExtractionDialogA dialog window for managing properties for writing meshes to files
 CTreeItemObjects nodes for the TreeModel
 CTreeModelA hierarchical model for a tree implemented as a double-linked list
 CTreeModelIteratorTreeModelIterator provides a way to iterate over TreeItems in a TreeModel
 CVisPrefsDialogA dialog window for settung up a visualisation preferences
 CVisualizationWidgetWidget containing the 3d VTK scene view
 CVtkAddFilterDialogDialog for selecting a filter to be applied to a VtkPipelineItem
 CVtkAlgorithmPropertiesContains properties for the visualization of objects as VtkVisPipelineItems
 CVtkAlgorithmPropertyCheckboxThis checkbox sets a user property on the given VtkAlgorithmProperties object automatically
 CVtkAlgorithmPropertyLineEditThis QLineEdit sets a user property on the given VtkAlgorithmProperties object automatically
 CVtkAlgorithmPropertyVectorEditThis edit widget consists of several QLineEdit to set a user vector property on the given VtkAlgorithmProperties object automatically
 CVtkAppendArrayFilter
 CVtkBGImageSourceUses an image source to create a plane in the 3D with the given image texture mapped on it
 CVtkColorByHeightFilterVTK filter object for colouring vtkPolyData objects based on z-coordinates
 CVtkColorLookupTableCalculates and stores a colour lookup table
 CVtkCompositeColorByHeightFilterThis filter colors the input by the points z-value
 CVtkCompositeColormapToImageFilterApplies a user adjustable color map to an image
 CVtkCompositeContourFilterVisualisation of contour-lines/-planes within dense scalar fields
 CVtkCompositeElementSelectionFilterThis filter selects/thresholds elements based on the selected array
 CVtkCompositeFilterIs used to combine several filter in one VtkVisPipelineItem
 CVtkCompositeGeoObjectFilterHightlights a single GeoObject
 CVtkCompositeImageToCylindersFilterCreates cylinders that stand on top of the image with the length of the corresponding first sub-pixel value (the red value)
 CVtkCompositeImageToPointCloudFilter
 CVtkCompositeImageToSurfacePointsFilter
 CVtkCompositeLineToTubeFilterConverts lines to tube-objects
 CVtkCompositeNodeSelectionFilterThis filter displays the points/nodes given in the index field as spheres
 CVtkCompositePointToGlyphFilterConverts point data to scalar-scaled spheres
 CVtkCompositeTextureOnSurfaceFilterPuts a texture on an object (and converts it into a vtkPolyData if necessary)
 CVtkCompositeThresholdFilterVisualises only parts of meshes that are above/below/within given thresholds
 CVtkConsoleOutputWindowVtkWin32ConsoleOutputWindow is used to suppress message boxes on Windows
 CVtkCustomInteractorStyleVtkCustomInteractorStyle implements highlighting of an active actor and highlighting of picked cells inside a vtk object
 CVtkFilterFactoryCreates registered filter objects by name
 CVtkFilterInfoHolds meta information about a filter
 CVtkGeoImageSourceThe VtkVisPipeline source object of a geo-referenced image (file)
 CVtkImageDataToLinePolyDataFilterCreates lines that stand on top of the image with the length of the corresponding first sub-pixel value (the grey or red value)
 CVtkImageDataToPointCloudFilterA VTK Filter that will create a point cloud with local densities based on pixel values
 CVtkImageDataToSurfacePointsFilterA VTK filter that creates a point cloud representing a surface defined by pixel values
 CVtkPickCallbackVtkPickCallback is a vtkCommand that implements functionality when picking a vtk object through a vtkCellPicker
 CVtkPointsSourceVtkPointsSource is a VTK source object for the visualization of point data
 CVtkPolylinesSourceVtkPolylinesSource is a VTK source object for the visualisation of polyline data
 CVtkRasterLoading raster data such as images or ArcGIS-data into VTK image data structures
 CVtkStationSourceVTK source object for the visualisation of station data (including boreholes)
 CVtkSurfacesSourceVTK source object for the visualisation of surfaces
 CVtkTextureOnSurfaceFilterFilter class for assigning a texture to a surface
 CVtkVisHelperSome data conversion helper functions
 CVtkVisImageItemAn item in the VtkVisPipeline containing an image to be visualized
 CVtkVisPipelineVtkVisPipeline manages the VTK visualization
 CVtkVisPipelineItemAn item in the VtkVisPipeline containing a graphic object to be visualized
 CVtkVisPipelineViewVtkVisPipelineView is a QTreeView and shows VtkVisPipelineItems and their relation to each other
 CVtkVisPointSetItemAn item in the VtkVisPipeline containing a point set object to be visualized
 CVtkVisTabWidgetContains a QTreeView of the VtkVisPipeline and a properties panel for adjusting vtkAlgorithms rendering and filter settings