diff --git a/Applications/ApplicationsLib/LinearSolverLibrarySetup.h b/Applications/ApplicationsLib/LinearSolverLibrarySetup.h index 3ec66753d73748dedb94c0fb260708b256ffe743..86003d18b190dcc12f14f41b3158d1671b65b089 100644 --- a/Applications/ApplicationsLib/LinearSolverLibrarySetup.h +++ b/Applications/ApplicationsLib/LinearSolverLibrarySetup.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/ApplicationsLib/ProjectData.cpp b/Applications/ApplicationsLib/ProjectData.cpp index 3d9687070b72105c50b2ee14c3a283e0446f3850..d1f532f8636482decc441ede1143c42e1300dd60 100644 --- a/Applications/ApplicationsLib/ProjectData.cpp +++ b/Applications/ApplicationsLib/ProjectData.cpp @@ -1,4 +1,5 @@ /** + * \file * \author Karsten Rink * \date 2010-08-25 * \brief Implementation of the project data class. diff --git a/Applications/ApplicationsLib/ProjectData.h b/Applications/ApplicationsLib/ProjectData.h index d08e20b568eacaa817fd17d75f8bd6a1bcb03f7f..53704d198b746fd0eaf0326e96d804d744193dd6 100644 --- a/Applications/ApplicationsLib/ProjectData.h +++ b/Applications/ApplicationsLib/ProjectData.h @@ -1,4 +1,5 @@ /** + * \file * \author Karsten Rink * \date 2010-08-25 * diff --git a/Applications/ApplicationsLib/Simulation.cpp b/Applications/ApplicationsLib/Simulation.cpp index e8e2aaf8c56c17a48d6ee81d1a0bc65fce9d52d5..7b5656150b8d3077af7d959c09ba81d3a4a88404 100644 --- a/Applications/ApplicationsLib/Simulation.cpp +++ b/Applications/ApplicationsLib/Simulation.cpp @@ -1,6 +1,6 @@ /** - * \brief Implementation of class Simulation * \file + * \brief Implementation of class Simulation * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/ApplicationsLib/Simulation.h b/Applications/ApplicationsLib/Simulation.h index f14a5f29e86fcca593c9bbc14e64f3e90581cf9a..40537474a0d6ff8ee0918a654e25e134517b44ad 100644 --- a/Applications/ApplicationsLib/Simulation.h +++ b/Applications/ApplicationsLib/Simulation.h @@ -1,6 +1,6 @@ /** - * \brief Declaration of class Simulation * \file + * \brief Declaration of class Simulation * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/CLI/CommandLineArgumentParser.cpp b/Applications/CLI/CommandLineArgumentParser.cpp index cd9733af9228f5183977214b69b3f0521c2d09cf..cc238ce7a10094fd3e96ce7441c7398be8c636c6 100644 --- a/Applications/CLI/CommandLineArgumentParser.cpp +++ b/Applications/CLI/CommandLineArgumentParser.cpp @@ -1,6 +1,6 @@ /** - * \brief Implementation of CommandLineArgumentParser. * \file + * \brief Implementation of CommandLineArgumentParser. * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/CLI/CommandLineArgumentParser.h b/Applications/CLI/CommandLineArgumentParser.h index d3af396fb900ac438ca5b86e189af6fb4fc1bf78..6d30c1929a7bbc737aa9752a789fb0309f251ce1 100644 --- a/Applications/CLI/CommandLineArgumentParser.h +++ b/Applications/CLI/CommandLineArgumentParser.h @@ -1,6 +1,6 @@ /** - * \brief Declaration of CommandLineArgumentParser. * \file + * \brief Declaration of CommandLineArgumentParser. * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/CLI/ogs.cpp b/Applications/CLI/ogs.cpp index 573259779a8e494ae2aad2ad90986be77bc02743..edd773399389212e6470a6c6e1baf67f14586658 100644 --- a/Applications/CLI/ogs.cpp +++ b/Applications/CLI/ogs.cpp @@ -1,4 +1,5 @@ /** + * \file * \date 2014-08-04 * \brief Implementation of OpenGeoSys simulation application * diff --git a/Applications/CLI/ogs_embedded_python.cpp b/Applications/CLI/ogs_embedded_python.cpp index 10ffa80419d7a1b09488bc9101b1424291216962..b3c2c1cec9d7d8b5512b7efd7325eaa5fe1cea1e 100644 --- a/Applications/CLI/ogs_embedded_python.cpp +++ b/Applications/CLI/ogs_embedded_python.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/CLI/ogs_embedded_python.h b/Applications/CLI/ogs_embedded_python.h index 7445abfabb006683bec14c5f8acfe004a2bc4bb2..c1616f936817e3441b2673878d1e6d1b874a2706 100644 --- a/Applications/CLI/ogs_embedded_python.h +++ b/Applications/CLI/ogs_embedded_python.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataExplorer/DataView/MeshMapping2DDialog.cpp b/Applications/DataExplorer/DataView/MeshMapping2DDialog.cpp index dd4eb6ee746a23cc28355df6f3fbb9c0294b8e72..cee8aa5ca16c31894f73d42d30b9352194f28d99 100644 --- a/Applications/DataExplorer/DataView/MeshMapping2DDialog.cpp +++ b/Applications/DataExplorer/DataView/MeshMapping2DDialog.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataExplorer/DataView/MeshMapping2DDialog.h b/Applications/DataExplorer/DataView/MeshMapping2DDialog.h index 85fe333547a87e12f92cbf8c481395b733f9a928..adcb05567b6d30deaee4c8a0c2732c72d07dd21f 100644 --- a/Applications/DataExplorer/DataView/MeshMapping2DDialog.h +++ b/Applications/DataExplorer/DataView/MeshMapping2DDialog.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.cpp b/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.cpp index 5ebb35513ff24a9f3695cbd934ffa0b8dd75b23c..5de142be9cbc1263f233efb3f1805e8c8b874c0d 100644 --- a/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.cpp +++ b/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (https://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.h b/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.h index 242283ca117ff81801742e970937387b9c23c010..05d446cfa56e479e491b492174a33b11d79bab30 100644 --- a/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.h +++ b/Applications/DataExplorer/VtkVis/NetCdfConfigureDialog.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (https://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataExplorer/VtkVis/VtkAppendArrayFilter.h b/Applications/DataExplorer/VtkVis/VtkAppendArrayFilter.h index 8ed0acb55e51d91ca5240dfec051662c31a814fc..65a9a23aa7594080f531cf6a9e80ad9d6301e65f 100644 --- a/Applications/DataExplorer/VtkVis/VtkAppendArrayFilter.h +++ b/Applications/DataExplorer/VtkVis/VtkAppendArrayFilter.h @@ -22,7 +22,6 @@ #include <vector> /** - * \brief */ class VtkAppendArrayFilter : public vtkUnstructuredGridAlgorithm, public VtkAlgorithmProperties { diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeFilter.h b/Applications/DataExplorer/VtkVis/VtkCompositeFilter.h index 49cadaf8953e01056b3bd852714de6c0a053b08b..a6ff40976c5b71c25b66224106f60eaaccd14f37 100644 --- a/Applications/DataExplorer/VtkVis/VtkCompositeFilter.h +++ b/Applications/DataExplorer/VtkVis/VtkCompositeFilter.h @@ -19,7 +19,7 @@ class vtkAlgorithm; /** - * @brief Is used to combine several filter in one VtkVisPipelineItem. You can + * \brief Is used to combine several filter in one VtkVisPipelineItem. You can * use vtk filter and custom filter. To subclass this you have to implement the * init() function. There you combine the filters. Make sure to set the members * _inputDataObjectType, _outputDataObjectType and _outputAlgorithm. Make also @@ -33,10 +33,10 @@ class vtkAlgorithm; * ...(do something here) * _outputAlgorithm = lastFilter; * - * Create user properties with `ogsUserPropertyMacro` or `ogsUserVecxPropertyMacro` - * and initialize these properties inside the constructor with - * `this->Set[Property Name](value)`. - * See VtkCompositeThresholdFilter for an example. + * Create user properties with `ogsUserPropertyMacro` or + * `ogsUserVecxPropertyMacro` and initialize these properties inside the + * constructor with `this->Set[Property Name](value)`. See + * VtkCompositeThresholdFilter for an example. */ class VtkCompositeFilter : public VtkAlgorithmProperties { diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.cpp b/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.cpp index 9dedeff49cce0fdb71a63b8a69674b081b1b36a3..32906c13ca8bcd4b8a78aff5e5edfb5aa70de814 100644 --- a/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.cpp +++ b/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.h b/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.h index c23d6ec8918d910e4271957be57f932433672f13..d0b2d4a07a9b6bbf3ac3f7aa9a635f88f44c1c3e 100644 --- a/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.h +++ b/Applications/DataExplorer/VtkVis/VtkCompositeImageToPointCloudFilter.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.cpp b/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.cpp index 631e345b23eab1474502f22b975d4faebd867d6e..facc5aa7cc8a0d45858d92187a8719be67efc025 100644 --- a/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.cpp +++ b/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.h b/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.h index b5071c04e13063d17b34d3a2f6a71182ae029187..244106e37426847f79c2c3222727b033fe36a97c 100644 --- a/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.h +++ b/Applications/DataExplorer/VtkVis/VtkCompositeImageToSurfacePointsFilter.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.cpp b/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.cpp index 897491af9403ecd957c5f9a724cbc362e5467b55..0e6b9878d9ba836817f52ed11726211d479b8462 100644 --- a/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.cpp +++ b/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.h b/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.h index f1cfe7fe10ba7186c8af39ff5e6406df3332c8a1..8a77a0d0d6ca65d70c606507a58868a6876e8106 100644 --- a/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.h +++ b/Applications/DataExplorer/VtkVis/VtkConsoleOutputWindow.h @@ -1,4 +1,5 @@ /** + * \file * \brief VtkWin32ConsoleOutputWindow is used to suppress message boxes on * Windows. * diff --git a/Applications/DataHolderLib/ColorLookupTable.cpp b/Applications/DataHolderLib/ColorLookupTable.cpp index 4c0e371e14014ab8a7fdbe2717db5e8c8947c7ba..ef81c9fcb1fa08f99072566e12b74f6d137980ce 100644 --- a/Applications/DataHolderLib/ColorLookupTable.cpp +++ b/Applications/DataHolderLib/ColorLookupTable.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/DataHolderLib/ColorLookupTable.h b/Applications/DataHolderLib/ColorLookupTable.h index e9180a25cafaee8044c61229718073594f7d792a..0fb8c4840b51738267101521ad61ef30003794bd 100644 --- a/Applications/DataHolderLib/ColorLookupTable.h +++ b/Applications/DataHolderLib/ColorLookupTable.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/FileIO/CsvInterface.cpp b/Applications/FileIO/CsvInterface.cpp index aeaa8623494b7055b179b5e83394b514e542be64..552437f8fbbac4a0f98561d5cfcf4554ae35a441 100644 --- a/Applications/FileIO/CsvInterface.cpp +++ b/Applications/FileIO/CsvInterface.cpp @@ -1,10 +1,10 @@ /** - * @file CsvInterface.cpp - * @author Karsten Rink - * @date 2015-03-25 - * @brief Implementation of the CsvInterface class. + * \file + * \author Karsten Rink + * \date 2015-03-25 + * \brief Implementation of the CsvInterface class. * - * @copyright + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or diff --git a/Applications/FileIO/CsvInterface.h b/Applications/FileIO/CsvInterface.h index c914fb4312a7611f5dfda5f2b113e4608ad9a709..6bbc1f4d505f73fa9371ed4efdd837a90d7e479c 100644 --- a/Applications/FileIO/CsvInterface.h +++ b/Applications/FileIO/CsvInterface.h @@ -1,10 +1,10 @@ /** - * @file CsvInterface.h - * @author Karsten Rink - * @date 2015-03-25 - * @brief Definition of the CsvInterface class. + * \file + * \author Karsten Rink + * \date 2015-03-25 + * \brief Definition of the CsvInterface class. * - * @copyright + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or diff --git a/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.cpp b/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.cpp index f9968081131ebb4c1eb6c070b1da43f5a7e0006c..a0040cf72c428e05186ab5122f938dfad3c99d47 100644 --- a/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.cpp +++ b/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.h b/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.h index 07a9e36737dde330c7f286a3041209145a282e3f..e0634a2c86a961c22e40ccaf7a6468e4cec5877a 100644 --- a/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.h +++ b/Applications/FileIO/FEFLOW/FEFLOWGeoInterface.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.cpp b/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.cpp index ce3156c94028562f8d5f9d0e737f59ed84541809..2f2748ada08ab791ccdcef44e7c5f26043f4a1ed 100644 --- a/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.cpp +++ b/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.h b/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.h index 1c9bb987443d7e65e89a773ad904622dc3b1967e..18e52054f151e55c152094e4cc33d22fde426ce3 100644 --- a/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.h +++ b/Applications/FileIO/FEFLOW/FEFLOWMeshInterface.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/FileIO/GMSInterface.cpp b/Applications/FileIO/GMSInterface.cpp index 85c2711c98f5f9fb6cea8c7eaffd63db7221271f..408b9df1b10d2f73f5b9342fdfed9ab98e26839b 100644 --- a/Applications/FileIO/GMSInterface.cpp +++ b/Applications/FileIO/GMSInterface.cpp @@ -9,10 +9,6 @@ * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license - * - * @file GMSInterface.cpp - * @date 2010-06-08 - * @author Karsten Rink */ #include "GMSInterface.h" diff --git a/Applications/FileIO/GMSInterface.h b/Applications/FileIO/GMSInterface.h index dd40c05eee610ceb84b13b157866af259c5c7a4b..7ced0683d427a114aae9e7ebc59b2fde385ae771 100644 --- a/Applications/FileIO/GMSInterface.h +++ b/Applications/FileIO/GMSInterface.h @@ -1,6 +1,7 @@ /** * \file * \author Karsten Rink + * \author Lars Bilke * \date 2010-06-08 * \brief Definition of the GMSInterface class. * @@ -9,10 +10,6 @@ * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license - * - * @file GMSInterface.h - * @date 2010-06-08 - * @author Lars Bilke */ #pragma once diff --git a/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.cpp b/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.cpp index 701f7a5f7380de199e11b1108045323c6168570c..d341a018aef3fcd2469c469fe8ffd2cea78c36da 100644 --- a/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.cpp +++ b/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) @@ -6,9 +7,8 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * @file GMSHAdaptiveMeshDensity.cpp - * @date 2012-03-05 - * @author Thomas Fischer + * \date 2012-03-05 + * \author Thomas Fischer */ #include "GMSHAdaptiveMeshDensity.h" diff --git a/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.h b/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.h index 2a97b141892c796592c54cf4d5234884d8e21f13..850b9ec247abec7e08e7c6d2a2565d22ef8ba499 100644 --- a/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.h +++ b/Applications/FileIO/Gmsh/GMSHAdaptiveMeshDensity.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.cpp b/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.cpp index f8732f920c6d3dc50cb3fe7ce9fcbecc1b208eb1..665a6d60c1fc058f14818f7a75adf55e21b0f8bd 100644 --- a/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.cpp +++ b/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.h b/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.h index 5d22c2d0bba54f07a51fd4798e02502457205ef0..751f2b739282474f3ac32ff6894984e887cb03be 100644 --- a/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.h +++ b/Applications/FileIO/Gmsh/GMSHFixedMeshDensity.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHInterface.cpp b/Applications/FileIO/Gmsh/GMSHInterface.cpp index 550e1b270437bee8ab211546dda17ad636d214b9..2fe72f0a37102bfcf1c4461c9b7d72508a6c54d7 100644 --- a/Applications/FileIO/Gmsh/GMSHInterface.cpp +++ b/Applications/FileIO/Gmsh/GMSHInterface.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHInterface.h b/Applications/FileIO/Gmsh/GMSHInterface.h index ef5d8581b3098c56318ecb11d614b130a9c2a293..c9ff2ff70563d3d46d72ae9e544f7b818436cd82 100644 --- a/Applications/FileIO/Gmsh/GMSHInterface.h +++ b/Applications/FileIO/Gmsh/GMSHInterface.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHLine.cpp b/Applications/FileIO/Gmsh/GMSHLine.cpp index 11932b5d924f6f2dba7c68a6b59d57b54fc7139a..a308fbe1e7c3c0a015792c0e8507b508b8a87a59 100644 --- a/Applications/FileIO/Gmsh/GMSHLine.cpp +++ b/Applications/FileIO/Gmsh/GMSHLine.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHLine.h b/Applications/FileIO/Gmsh/GMSHLine.h index 1b72a005ee443a28d7b62d57119014fe550e99c7..f6fcb4308b45115a484584bb4602bfc9d4c94f9b 100644 --- a/Applications/FileIO/Gmsh/GMSHLine.h +++ b/Applications/FileIO/Gmsh/GMSHLine.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHLineLoop.cpp b/Applications/FileIO/Gmsh/GMSHLineLoop.cpp index 9dd4d496e89c3933e218c9368c8dbe2abc5fe9bf..2a29e0bbbd35fdb871828ebdd0bb765fea2496e5 100644 --- a/Applications/FileIO/Gmsh/GMSHLineLoop.cpp +++ b/Applications/FileIO/Gmsh/GMSHLineLoop.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHLineLoop.h b/Applications/FileIO/Gmsh/GMSHLineLoop.h index 29699eada13e142a307b71943aa2bfc67d685da1..69eb92e125f55193a767db5f14b97b01463d60aa 100644 --- a/Applications/FileIO/Gmsh/GMSHLineLoop.h +++ b/Applications/FileIO/Gmsh/GMSHLineLoop.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHMeshDensityStrategy.h b/Applications/FileIO/Gmsh/GMSHMeshDensityStrategy.h index 96803e4caa1c031d3e82220d2a100a4a8607959e..ea29ab0a071a76608abf2c374fd5c89db364652c 100644 --- a/Applications/FileIO/Gmsh/GMSHMeshDensityStrategy.h +++ b/Applications/FileIO/Gmsh/GMSHMeshDensityStrategy.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHPoint.cpp b/Applications/FileIO/Gmsh/GMSHPoint.cpp index e55cf14242469ed963ccf522cb5c4a335e00c9e7..9ddd37da6f653ab0f31c7ffcc27d62388e7b8643 100644 --- a/Applications/FileIO/Gmsh/GMSHPoint.cpp +++ b/Applications/FileIO/Gmsh/GMSHPoint.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHPoint.h b/Applications/FileIO/Gmsh/GMSHPoint.h index 55a79092df3e18c61620edc7789980d1f1efba4a..40df88033807a141ad8cd3e9969eeff23dcd3d1b 100644 --- a/Applications/FileIO/Gmsh/GMSHPoint.h +++ b/Applications/FileIO/Gmsh/GMSHPoint.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHPolygonTree.cpp b/Applications/FileIO/Gmsh/GMSHPolygonTree.cpp index 46f870fbfce52b5ffab30ab3c0f58c042b127c96..92555dd3c6dc74710dc130a4e67c6b771bd8046b 100644 --- a/Applications/FileIO/Gmsh/GMSHPolygonTree.cpp +++ b/Applications/FileIO/Gmsh/GMSHPolygonTree.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GMSHPolygonTree.h b/Applications/FileIO/Gmsh/GMSHPolygonTree.h index 999467c9d6502e6aaf8f7a533cd033d2354eff7a..e41c0b6f09dd25f9fed5ba9be5f4f81c257fe31b 100644 --- a/Applications/FileIO/Gmsh/GMSHPolygonTree.h +++ b/Applications/FileIO/Gmsh/GMSHPolygonTree.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GmshReader.cpp b/Applications/FileIO/Gmsh/GmshReader.cpp index b18a9348815d895837504837f9894f4e364193f6..2aa7f8caa93839efa4ae2e66c0cd60aad1613ca4 100644 --- a/Applications/FileIO/Gmsh/GmshReader.cpp +++ b/Applications/FileIO/Gmsh/GmshReader.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Gmsh/GmshReader.h b/Applications/FileIO/Gmsh/GmshReader.h index 9a4a748bf39b56eb2118cfb19d2e4570999a09af..51dbbbb40851eb848ff63361b47b4ef2ff8c6fba 100644 --- a/Applications/FileIO/Gmsh/GmshReader.h +++ b/Applications/FileIO/Gmsh/GmshReader.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) @@ -21,16 +22,16 @@ namespace GMSH /** * checks if there is a GMSH mesh file header - * @param fname the file name of the mesh (including the path) - * @return true, if the file seems to be a valid GMSH file, else false + * \param fname the file name of the mesh (including the path) + * \return true, if the file seems to be a valid GMSH file, else false */ bool isGMSHMeshFile(const std::string& fname); /** * reads a mesh created by GMSH - this implementation is based on the former * function GMSH2MSH - * @param fname the file name of the mesh (including the path) - * @return + * \param fname the file name of the mesh (including the path) + * \return */ MeshLib::Mesh* readGMSHMesh(std::string const& fname); diff --git a/Applications/FileIO/GocadIO/GocadEnums.cpp b/Applications/FileIO/GocadIO/GocadEnums.cpp index 91da249c1ef80bab0a1d74d0a43885a6bd58aa82..277cc290a7616069fb282d7e71a1017d1da98333 100644 --- a/Applications/FileIO/GocadIO/GocadEnums.cpp +++ b/Applications/FileIO/GocadIO/GocadEnums.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/FileIO/GocadIO/GocadEnums.h b/Applications/FileIO/GocadIO/GocadEnums.h index aeb30fa82b6b293ce9c5d0aa329168c18004ea67..e3f40df9edc15e39d3551760b6dc28a14f4a1070 100644 --- a/Applications/FileIO/GocadIO/GocadEnums.h +++ b/Applications/FileIO/GocadIO/GocadEnums.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/FileIO/GocadIO/GocadSGridReader.cpp b/Applications/FileIO/GocadIO/GocadSGridReader.cpp index 931855b6ff60dfa37093d15d4ecbce8c32974a3a..3a3523b310578c50a39ff95fde338437d6417be0 100644 --- a/Applications/FileIO/GocadIO/GocadSGridReader.cpp +++ b/Applications/FileIO/GocadIO/GocadSGridReader.cpp @@ -280,8 +280,8 @@ void GocadSGridReader::parseFileName(std::string const& line, } /** - * @param line input/output - * @param in input stream containing the face set + * \param line input/output + * \param in input stream containing the face set */ void GocadSGridReader::parseFaceSet(std::string& line, std::istream& in) { diff --git a/Applications/FileIO/Legacy/createSurface.cpp b/Applications/FileIO/Legacy/createSurface.cpp index b374f1a6090640bd658c39ddfbe06e5b66b34650..c21bd3a209741c73220a5e8ff73ac65bb913fb2f 100644 --- a/Applications/FileIO/Legacy/createSurface.cpp +++ b/Applications/FileIO/Legacy/createSurface.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/Legacy/createSurface.h b/Applications/FileIO/Legacy/createSurface.h index 4f68a40b8b606a649ff29c47cf11ff4fb7052e7d..2415a06ff4e823cddd6b304b228cc958fcb08e56 100644 --- a/Applications/FileIO/Legacy/createSurface.h +++ b/Applications/FileIO/Legacy/createSurface.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/PetrelInterface.cpp b/Applications/FileIO/PetrelInterface.cpp index e0a84c00aba5018d8f3072b62c149046b477a658..e1c50a8f2177e9bf540dad15883d81780292bd15 100644 --- a/Applications/FileIO/PetrelInterface.cpp +++ b/Applications/FileIO/PetrelInterface.cpp @@ -9,10 +9,6 @@ * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license - * - * @file PetrelInterface.cpp - * @date 2010-02-16 - * @author Thomas Fischer */ #include "PetrelInterface.h" diff --git a/Applications/FileIO/PetrelInterface.h b/Applications/FileIO/PetrelInterface.h index ab85fa584144167e0da20710459e90d2b759a3e7..df28c455c3f85c1354441f1bfa563ea28be5e36e 100644 --- a/Applications/FileIO/PetrelInterface.h +++ b/Applications/FileIO/PetrelInterface.h @@ -9,10 +9,6 @@ * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license - * - * @file PetrelInterface.h - * @date 2010-02-16 - * @author Thomas Fischer */ #pragma once diff --git a/Applications/FileIO/SHPInterface.cpp b/Applications/FileIO/SHPInterface.cpp index 2d65825aa25a62e5e3f7d1471691aa939a6299b6..8071dc5d34a9355b04e00109cbb76570c1d441c1 100644 --- a/Applications/FileIO/SHPInterface.cpp +++ b/Applications/FileIO/SHPInterface.cpp @@ -9,10 +9,6 @@ * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license - * - * @file SHPInterface.cpp - * @date 25/01/2010 - * @author Karsten Rink */ #include "SHPInterface.h" diff --git a/Applications/FileIO/SHPInterface.h b/Applications/FileIO/SHPInterface.h index a628199ea76a940612e9d692a2f28f020b7c77d5..dc2b47f264c12057fedf9b818cd345cc1a61f7a6 100644 --- a/Applications/FileIO/SHPInterface.h +++ b/Applications/FileIO/SHPInterface.h @@ -9,10 +9,6 @@ * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license - * - * @file SHPInterface.h - * @date 25/01/2010 - * @author Karsten Rink */ #pragma once diff --git a/Applications/FileIO/SWMM/SWMMInterface.cpp b/Applications/FileIO/SWMM/SWMMInterface.cpp index 663eb8365620c99fc9a6c74118ab67755a09a122..b33a7901b8ca6e097f30f9194baa60b03b67a700 100644 --- a/Applications/FileIO/SWMM/SWMMInterface.cpp +++ b/Applications/FileIO/SWMM/SWMMInterface.cpp @@ -1,5 +1,6 @@ /** - * @copyright + * \file + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or diff --git a/Applications/FileIO/SWMM/SWMMInterface.h b/Applications/FileIO/SWMM/SWMMInterface.h index ff44a71c69801f2959115c3599d209b02d276e08..14e1b1ad06b3ddb9cbb078ff88c5cde837cb2735 100644 --- a/Applications/FileIO/SWMM/SWMMInterface.h +++ b/Applications/FileIO/SWMM/SWMMInterface.h @@ -1,4 +1,5 @@ /** + * \file * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or diff --git a/Applications/FileIO/readGeometryFromFile.cpp b/Applications/FileIO/readGeometryFromFile.cpp index a13ae5f57c1881f9b983cec7d68afebcdcdc4db3..367ee9c97e49eb02fa81102e6cfe309e72336b23 100644 --- a/Applications/FileIO/readGeometryFromFile.cpp +++ b/Applications/FileIO/readGeometryFromFile.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/readGeometryFromFile.h b/Applications/FileIO/readGeometryFromFile.h index 47cdf3dff47cdcb3cabf8af659a7fc4012cd55a1..4aa9168b20dc59e1311ef20603bad70ace964e24 100644 --- a/Applications/FileIO/readGeometryFromFile.h +++ b/Applications/FileIO/readGeometryFromFile.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/writeGeometryToFile.cpp b/Applications/FileIO/writeGeometryToFile.cpp index d226f9be49a00c18e3022fdea7e1e9343afc06f8..21ba334677b6946afef4290f563938f68d73253e 100644 --- a/Applications/FileIO/writeGeometryToFile.cpp +++ b/Applications/FileIO/writeGeometryToFile.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/FileIO/writeGeometryToFile.h b/Applications/FileIO/writeGeometryToFile.h index 4a7a0f10934e04e2b0a9db83c8b482d423463ef1..cf83190b938b6826926ac61823cfdc3dea52bdab 100644 --- a/Applications/FileIO/writeGeometryToFile.h +++ b/Applications/FileIO/writeGeometryToFile.h @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/InSituLib/Adaptor.cpp b/Applications/InSituLib/Adaptor.cpp index f9bf0d75388de3757eb454c877a25d2a5f6fac15..66326480232bb1af4caaa94fc9171bc021760d9b 100644 --- a/Applications/InSituLib/Adaptor.cpp +++ b/Applications/InSituLib/Adaptor.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/InSituLib/Adaptor.h b/Applications/InSituLib/Adaptor.h index e1a1e54d8ccc6b4ee4727e13fb44b7213f90ed47..f6eb6e3c0ee5f1e8e096ee528e2faaa39c2a102e 100644 --- a/Applications/InSituLib/Adaptor.h +++ b/Applications/InSituLib/Adaptor.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/Python/ogs.callbacks/ogs_callbacks_module.cpp b/Applications/Python/ogs.callbacks/ogs_callbacks_module.cpp index 6f4f8d38ce861b5c0d43560a8cbacac36f324636..8f5bdca649117518f5a9d649e32c3e265c96247e 100644 --- a/Applications/Python/ogs.callbacks/ogs_callbacks_module.cpp +++ b/Applications/Python/ogs.callbacks/ogs_callbacks_module.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/Python/ogs.simulator/ogs_python_module.cpp b/Applications/Python/ogs.simulator/ogs_python_module.cpp index 1fbb02cf0c2a719db9293233f08c2c6b44df638e..340b525515bf378505dbd117a3a1debe861cb642 100644 --- a/Applications/Python/ogs.simulator/ogs_python_module.cpp +++ b/Applications/Python/ogs.simulator/ogs_python_module.cpp @@ -1,6 +1,6 @@ /** - * \brief Implementation of OpenGeoSys simulation application python module * \file + * \brief Implementation of OpenGeoSys simulation application python module * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/Utils/FileConverter/FEFLOW2OGS.cpp b/Applications/Utils/FileConverter/FEFLOW2OGS.cpp index 769c39e7b1e7145cf1c029ec2af3bd5dcb92ea32..22325bf183cd67e70a43d93a0cd543d367fc9b7f 100644 --- a/Applications/Utils/FileConverter/FEFLOW2OGS.cpp +++ b/Applications/Utils/FileConverter/FEFLOW2OGS.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/Utils/FileConverter/Raster2ASC.cpp b/Applications/Utils/FileConverter/Raster2ASC.cpp index 0fc08949705c68a962514ffb59326d09eb81e27e..c5dc5a899a89d3509c3828f33698e52c4016650c 100644 --- a/Applications/Utils/FileConverter/Raster2ASC.cpp +++ b/Applications/Utils/FileConverter/Raster2ASC.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/Utils/FileConverter/convertGEO.cpp b/Applications/Utils/FileConverter/convertGEO.cpp index 94d860e105f8197c5eec440daf3f17ac35814a20..aaf6d862763e384765635dd836ebace58a712319 100644 --- a/Applications/Utils/FileConverter/convertGEO.cpp +++ b/Applications/Utils/FileConverter/convertGEO.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/Utils/GeoTools/addDataToRaster.cpp b/Applications/Utils/GeoTools/addDataToRaster.cpp index 8c177ce7367030cfa81a3b32b89e781be73b7084..96f6e2097f4898668a07ef4f6274e7021b71c149 100644 --- a/Applications/Utils/GeoTools/addDataToRaster.cpp +++ b/Applications/Utils/GeoTools/addDataToRaster.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/Utils/GeoTools/createRaster.cpp b/Applications/Utils/GeoTools/createRaster.cpp index eb3d667135d8dff9a07196127d4d4001bb2075a2..450fa3d4ca343b5b2acda1ee93c816476ab1956b 100644 --- a/Applications/Utils/GeoTools/createRaster.cpp +++ b/Applications/Utils/GeoTools/createRaster.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/Utils/MeshEdit/CreateBoundaryConditionsAlongPolylines.cpp b/Applications/Utils/MeshEdit/CreateBoundaryConditionsAlongPolylines.cpp index 89f083e3ac9692ea1351b9d1919f02618439d222..912ec21b84beaa0799a0b7a1b08430c1bf099d0a 100644 --- a/Applications/Utils/MeshEdit/CreateBoundaryConditionsAlongPolylines.cpp +++ b/Applications/Utils/MeshEdit/CreateBoundaryConditionsAlongPolylines.cpp @@ -1,4 +1,5 @@ /* + * \file * \date 2014-09-30 * \brief Create BoundaryConditions from a polylines. * diff --git a/Applications/Utils/MeshEdit/MapGeometryToMeshSurface.cpp b/Applications/Utils/MeshEdit/MapGeometryToMeshSurface.cpp index 39659619aad17297ccbf64cf2c5465cdc1ad22f5..8e521112cd5b4258e664003a406df49b11f12959 100644 --- a/Applications/Utils/MeshEdit/MapGeometryToMeshSurface.cpp +++ b/Applications/Utils/MeshEdit/MapGeometryToMeshSurface.cpp @@ -1,4 +1,5 @@ /* + * \file * \date 2015-04-20 * \brief Map geometric objects to the surface of the given mesh. * diff --git a/Applications/Utils/MeshEdit/MoveMesh.cpp b/Applications/Utils/MeshEdit/MoveMesh.cpp index f2ea9593382797d7dffd794b932962c9de46c9ed..d18ad4c2d861d8837331625f382e48f3dccae915 100644 --- a/Applications/Utils/MeshEdit/MoveMesh.cpp +++ b/Applications/Utils/MeshEdit/MoveMesh.cpp @@ -1,7 +1,6 @@ /** - * @file MoveMesh.cpp - * @date Jan 17, 2014 - * @brief + * \file + * \date Jan 17, 2014 * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/Utils/MeshEdit/ResetPropertiesInPolygonalRegion.cpp b/Applications/Utils/MeshEdit/ResetPropertiesInPolygonalRegion.cpp index 8c7311a6c7437a8a80035f9facddcb6150635fed..8fefef0f2037aaae3abd4888f98241c8868d262d 100644 --- a/Applications/Utils/MeshEdit/ResetPropertiesInPolygonalRegion.cpp +++ b/Applications/Utils/MeshEdit/ResetPropertiesInPolygonalRegion.cpp @@ -1,4 +1,5 @@ /* + * \file * \brief Reset material properties in meshes in a polygonal region. * * \copyright diff --git a/Applications/Utils/MeshEdit/createLayeredMeshFromRasters.cpp b/Applications/Utils/MeshEdit/createLayeredMeshFromRasters.cpp index 70e33fbbe9caa3d03d80cefe3ce136b0042aa862..159f41e90503e03904f181690da6c3738ab74d19 100644 --- a/Applications/Utils/MeshEdit/createLayeredMeshFromRasters.cpp +++ b/Applications/Utils/MeshEdit/createLayeredMeshFromRasters.cpp @@ -1,4 +1,5 @@ /* + * \file * \date 2016-02-11 * \brief Creates a layered mesh from a 2D mesh and a bunch of raster files. * diff --git a/Applications/Utils/MeshGeoTools/constructMeshesFromGeometry.cpp b/Applications/Utils/MeshGeoTools/constructMeshesFromGeometry.cpp index af944e29b59080d69d39fd8b00f8003aff13fa03..431f220ad0737441e4836625adb68b5b6207ba57 100644 --- a/Applications/Utils/MeshGeoTools/constructMeshesFromGeometry.cpp +++ b/Applications/Utils/MeshGeoTools/constructMeshesFromGeometry.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/Utils/MeshGeoTools/identifySubdomains.cpp b/Applications/Utils/MeshGeoTools/identifySubdomains.cpp index 06aa08338fad06a863e6bf09baab5a0cc8eb0ac0..89d157ee1f56508221bba8a587cdf73a8fcb2294 100644 --- a/Applications/Utils/MeshGeoTools/identifySubdomains.cpp +++ b/Applications/Utils/MeshGeoTools/identifySubdomains.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/Utils/ModelPreparation/convertVtkDataArrayToVtkDataArray.cpp b/Applications/Utils/ModelPreparation/convertVtkDataArrayToVtkDataArray.cpp index a89bf8e3828b56a52b56a249fd21b2dbe6f840ca..d81c442f006759ed7e6b3a964cb111540f79abf2 100644 --- a/Applications/Utils/ModelPreparation/convertVtkDataArrayToVtkDataArray.cpp +++ b/Applications/Utils/ModelPreparation/convertVtkDataArrayToVtkDataArray.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/Utils/ModelPreparation/createNeumannBc.cpp b/Applications/Utils/ModelPreparation/createNeumannBc.cpp index c68c3839644704bfddf11e9355949514c50315fc..e3f2a40ef61115c331ad0e9ae255aba667ac30e5 100644 --- a/Applications/Utils/ModelPreparation/createNeumannBc.cpp +++ b/Applications/Utils/ModelPreparation/createNeumannBc.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Applications/Utils/ModelPreparation/scaleProperty.cpp b/Applications/Utils/ModelPreparation/scaleProperty.cpp index c73ee835450657679997fd2b4cd279dcd28fa497..e256280eecd692445530acec4383097cac607438 100644 --- a/Applications/Utils/ModelPreparation/scaleProperty.cpp +++ b/Applications/Utils/ModelPreparation/scaleProperty.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Applications/Utils/SWMMConverter/SWMMConverter.cpp b/Applications/Utils/SWMMConverter/SWMMConverter.cpp index a3df00d5fa27b03d03baa77287a59d8277937432..b2e120a5b60a6eab2b800ee58b18b38174b1c526 100644 --- a/Applications/Utils/SWMMConverter/SWMMConverter.cpp +++ b/Applications/Utils/SWMMConverter/SWMMConverter.cpp @@ -1,5 +1,6 @@ /** - * @copyright + * \file + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or diff --git a/Applications/Utils/SimpleMeshCreation/createMeshElemPropertiesFromASCRaster.cpp b/Applications/Utils/SimpleMeshCreation/createMeshElemPropertiesFromASCRaster.cpp index 205ad2d8102b68085737b628904f72ee6b4f083e..faad34bd1b7856b7a3f3482f111296a3034b6dc5 100644 --- a/Applications/Utils/SimpleMeshCreation/createMeshElemPropertiesFromASCRaster.cpp +++ b/Applications/Utils/SimpleMeshCreation/createMeshElemPropertiesFromASCRaster.cpp @@ -1,4 +1,5 @@ /** + * \file * \brief Implementation of the createMeshElemPropertiesFromASCRaster tool. * * \copyright diff --git a/BaseLib/TMP.h b/BaseLib/TMP.h index 51092ff468379b777b4054a136b43891084eb471..f8f89d5405915f99afa3ca5b6fd12884f4547848 100644 --- a/BaseLib/TMP.h +++ b/BaseLib/TMP.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/BaseLib/quicksort.h b/BaseLib/quicksort.h index 67dc055a1299d8a453afb9997455b87ae18016f2..10860075cda9af94d8da9d5b3a5739a8f109c59c 100644 --- a/BaseLib/quicksort.h +++ b/BaseLib/quicksort.h @@ -1,7 +1,7 @@ /** + * \file * \brief Definition of the quicksort function. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/ChemistryLib/PhreeqcIOData/Knobs.h b/ChemistryLib/PhreeqcIOData/Knobs.h index 265a2bf7c779adc69fc08d35dabf43a383ec7a6c..09722caf78a7bfcaa9bea46f19e66dbeec917885 100644 --- a/ChemistryLib/PhreeqcIOData/Knobs.h +++ b/ChemistryLib/PhreeqcIOData/Knobs.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Documentation/Namespaces.dox b/Documentation/Namespaces.dox deleted file mode 100644 index 42c9b5e8d1e8034404d481e14f319f82fbc460df..0000000000000000000000000000000000000000 --- a/Documentation/Namespaces.dox +++ /dev/null @@ -1,111 +0,0 @@ -/** - * \author Karsten Rink - * \date 2014-02-12 - * \brief Documentation of namespaces. - * - * \copyright - * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) - * Distributed under a Modified BSD License. - * See accompanying file LICENSE.txt or - * http://www.opengeosys.org/project/license - * - */ - -namespace AssemblerLib { - namespace detail { - } -} - -/** - * @namespace BaseLib - * Basic algorithms and helper functions provided for all other libraries. - */ -namespace BaseLib { -} - -/** - * @namespace FileIO - * Contains the interfaces for all file types that can be read and/or written using - * OpenGeoSys. - * - * \sa GMSH - * \sa Legacy - */ -namespace FileIO { - - /** - * @namespace FileIO::GMSH - * Sub-namespace containing all functionality needed for reading and writing GMSH files. - * - * \sa GMSHInterface - */ - namespace GMSH { - } - - /** - * @namespace FileIO::Legacy - * Includes the interfaces to OGS legacy file formats (OGS-5 and below). - */ - namespace Legacy { - } -} - -/** - * @namespace FiniteElement - */ -namespace FiniteElement { -} - -/** - * @namespace GeoLib - * Contains all functionality concerned with defining and obtaining information - * about geometric objects such as points, (poly-)lines, polygones, surfaces, etc. - * Also includes additional algorithms for modifying such data. - */ -namespace GeoLib { -} - -/** - * @namespace MathLib - * Contains all mathematical functionality used in OpenGeoSys, from defining a vector - * or calculating a norm to integration schemes and matrix preconditioners. - * - * \sa detail - */ -namespace MathLib { - /** - * @namespace MathLib::detail - */ - namespace detail { - } -} - -/** - * @namespace MeshLib - * Contains all functionality concerned with defining and obtaining information - * about meshes and their components (nodes, elements). Also includes additional - * algorithms for generating and modifying meshes and elements. - * - * \sa MeshGenerator - */ -namespace MeshLib { - /** - * @namespace MeshLib::MeshGenerator - * Functionality for generating meshing. - */ - namespace MeshGenerator { - } -} - -/** - * @namespace NumLib - * The numerical algorithms used in OpenGeoSys - */ -namespace NumLib { - /** - * @namespace NumLib::detail - */ - namespace detail { - } -} - diff --git a/GeoLib/AnalyticalGeometry.h b/GeoLib/AnalyticalGeometry.h index 95843224648c9c5fa75e5e5fc02fd5e79b80ca83..c4f2ba6c2f0cc88a61fce8eef3af539ad866608b 100644 --- a/GeoLib/AnalyticalGeometry.h +++ b/GeoLib/AnalyticalGeometry.h @@ -45,13 +45,16 @@ Orientation getOrientationFast(MathLib::Point3d const& p0, MathLib::Point3d const& p1, MathLib::Point3d const& p2); /** - * compute a supporting plane (represented by plane_normal and the value d) for the polygon - * Let \f$n\f$ be the plane normal and \f$d\f$ a parameter. Then for all points \f$p \in R^3\f$ of the plane - * it holds \f$ n \cdot p + d = 0\f$. The Newell algorithm is described in - * \cite Ericson:2004:RCD:1121584 . - * @param pnts_begin Iterator pointing to the initial point of a closed polyline describing a polygon - * @param pnts_end Iterator pointing to the element following the last point of a closed polyline describing a polygon - * @return pair of plane_normal and the parameter d: the normal of the plane the + * Compute a supporting plane (represented by plane_normal and the value d) for + * the polygon. + * Let \f$n\f$ be the plane normal and \f$d\f$ a parameter. Then for all points + * \f$p \in R^3\f$ of the plane it holds \f$ n \cdot p + d = 0\f$. + * The Newell algorithm is described in \cite Ericson:2004:RCD:1121584 . + * \param pnts_begin Iterator pointing to the initial point of a closed polyline + * describing a polygon + * \param pnts_end Iterator pointing to the element following the last point of + * a closed polyline describing a polygon + * \return pair of plane_normal and the parameter d: the normal of the plane the * polygon is located in, d parameter from the plane equation */ template <typename InputIterator> @@ -59,12 +62,13 @@ std::pair<Eigen::Vector3d, double> getNewellPlane(InputIterator pnts_begin, InputIterator pnts_end); /** - * compute a supporting plane (represented by plane_normal and the value d) for the polygon - * Let \f$n\f$ be the plane normal and \f$d\f$ a parameter. Then for all points \f$p \in R^3\f$ of the plane - * it holds \f$ n \cdot p + d = 0\f$. The Newell algorithm is described in - * \cite Ericson:2004:RCD:1121584 . - * @param pnts points of a closed polyline describing a polygon - * @return pair of plane_normal and the parameter d: the normal of the plane the + * Compute a supporting plane (represented by plane_normal and the value d) for + * the polygon. + * Let \f$n\f$ be the plane normal and \f$d\f$ a parameter. Then for all points + * \f$p \in R^3\f$ of the plane it holds \f$ n \cdot p + d = 0\f$. + * The Newell algorithm is described in \cite Ericson:2004:RCD:1121584 . + * \param pnts points of a closed polyline describing a polygon + * \return pair of plane_normal and the parameter d: the normal of the plane the * polygon is located in, parameter d from the plane equation */ template <class T_POINT> @@ -80,32 +84,35 @@ std::pair<Eigen::Vector3d, double> getNewellPlane( /** * Computes a rotation matrix that rotates the given 2D normal vector parallel * to X-axis - * @param v a 2D normal vector to be rotated - * @return a 3x3 rotation matrix where the upper, left, 2x2 block + * \param v a 2D normal vector to be rotated + * \return a 3x3 rotation matrix where the upper, left, 2x2 block * contains the entries necessary for the 2D rotation */ Eigen::Matrix3d compute2DRotationMatrixToX(Eigen::Vector3d const& v); /** - * Computes a rotation matrix that rotates the given 3D normal vector parallel to X-axis - * @param v a 3D normal vector to be rotated - * @return a 3x3 rotation matrix + * Computes a rotation matrix that rotates the given 3D normal vector parallel + * to X-axis. + * \param v a 3D normal vector to be rotated + * \return a 3x3 rotation matrix */ Eigen::Matrix3d compute3DRotationMatrixToX(Eigen::Vector3d const& v); /** * Method computes the rotation matrix that rotates the given vector parallel to * the \f$z\f$ axis. - * @param n the (3d) vector that is rotated parallel to the \f$z\f$ axis - * @return rot_mat 3x3 rotation matrix + * \param n the (3d) vector that is rotated parallel to the \f$z\f$ axis + * \return rot_mat 3x3 rotation matrix */ Eigen::Matrix3d computeRotationMatrixToXY(Eigen::Vector3d const& n); /** * rotate points according to the rotation matrix - * @param rot_mat 3x3 dimensional rotation matrix - * @param pnts_begin Iterator pointing to the initial element in a vector of points to be rotated - * @param pnts_end Iterator pointing to the element following the last element in a vector of points to be rotated + * \param rot_mat 3x3 dimensional rotation matrix + * \param pnts_begin Iterator pointing to the initial element in a vector of + * points to be rotated + * \param pnts_end Iterator pointing to the element following the last element + * in a vector of points to be rotated */ template <typename InputIterator> void rotatePoints(Eigen::Matrix3d const& rot_mat, InputIterator pnts_begin, @@ -113,28 +120,33 @@ void rotatePoints(Eigen::Matrix3d const& rot_mat, InputIterator pnts_begin, /** * rotate points according to the rotation matrix - * @param rot_mat 3x3 dimensional rotation matrix - * @param pnts vector of points + * \param rot_mat 3x3 dimensional rotation matrix + * \param pnts vector of points */ template <typename P> void rotatePoints(Eigen::Matrix3d const& rot_mat, std::vector<P*> const& pnts); /** * rotate points to X-Y plane - * @param pnts a vector of points with a minimum length of three. - * Points are rotated using a rotation matrix computed from the first three points - * in the vector. Point coordinates are modified as a result of the rotation. + * \param pnts a vector of points with a minimum length of three. + * Points are rotated using a rotation matrix computed from the first three + * points in the vector. Point coordinates are modified as a result of the + * rotation. */ Eigen::Matrix3d rotatePointsToXY(std::vector<Point*>& pnts); /** * rotate points to X-Y plane - * @param p_pnts_begin Iterator pointing to the initial element in a vector of points used for computing a rotation matrix - * @param p_pnts_end Iterator pointing to the element following the last point in a vector of points used for computing a rotation matrix - * @param r_pnts_begin Iterator pointing to the initial element in a vector of points to be rotated - * @param r_pnts_end Iterator pointing to the element following the last point in a vector of points to be rotated - * Points are rotated using a rotation matrix computed from the first three points - * in the vector. Point coordinates are modified as a result of the rotation. + * \param p_pnts_begin Iterator pointing to the initial element in a vector of + * points used for computing a rotation matrix + * \param p_pnts_end Iterator pointing to the element following the last point + * in a vector of points used for computing a rotation matrix + * \param r_pnts_begin Iterator pointing to the initial element in a vector of + * points to be rotated + * \param r_pnts_end Iterator pointing to the element following the last point + * in a vector of points to be rotated Points are rotated using a rotation + * matrix computed from the first three points in the vector. Point coordinates + * are modified as a result of the rotation. */ template <typename InputIterator1, typename InputIterator2> Eigen::Matrix3d rotatePointsToXY(InputIterator1 p_pnts_begin, @@ -144,11 +156,13 @@ Eigen::Matrix3d rotatePointsToXY(InputIterator1 p_pnts_begin, /** * test for intersections of the line segments of the Polyline - * @param ply the polyline - * @param seg_it0 iterator pointing to the first segment that has an intersection - * @param seg_it1 iterator pointing to the second segment that has an intersection - * @param intersection_pnt the intersection point if the segments intersect - * @return true, if the polyline contains intersections + * \param ply the polyline + * \param seg_it0 iterator pointing to the first segment that has an + * intersection + * \param seg_it1 iterator pointing to the second segment that has an + * intersection + * \param intersection_pnt the intersection point if the segments intersect + * \return true, if the polyline contains intersections */ bool lineSegmentsIntersect(const Polyline* ply, Polyline::SegmentIterator& seg_it0, @@ -157,19 +171,19 @@ bool lineSegmentsIntersect(const Polyline* ply, /** * Check if the two vectors \f$v, w \in R^3\f$ are in parallel - * @param v first vector - * @param w second vector - * @return true if the vectors are in parallel, else false -*/ + * \param v first vector + * \param w second vector + * \return true if the vectors are in parallel, else false + */ bool parallel(Eigen::Vector3d v, Eigen::Vector3d w); /** * A line segment is given by its two end-points. The function checks, * if the two line segments (ab) and (cd) intersects. - * @param s0 the first line segment. - * @param s1 the second line segment. - * @param s the intersection point if the segments do intersect - * @return true, if the line segments intersect, else false + * \param s0 the first line segment. + * \param s1 the second line segment. + * \param s the intersection point if the segments do intersect + * \return true, if the line segments intersect, else false */ bool lineSegmentIntersect(LineSegment const& s0, LineSegment const& s1, Point& s); @@ -189,7 +203,7 @@ std::vector<MathLib::Point3d> lineSegmentIntersect2d( /** * Calculates the intersection points of a line PQ and a triangle ABC. * This method requires ABC to be counterclockwise and PQ to point downward. - * @return Intersection point or nullptr if there is no intersection. + * \return Intersection point or nullptr if there is no intersection. */ std::unique_ptr<Point> triangleLineIntersection( MathLib::Point3d const& a, MathLib::Point3d const& b, @@ -211,8 +225,8 @@ void computeAndInsertAllIntersectionPoints(PointVec& pnt_vec, * (getNewellPlane()) and the points are rotated, (3) for accuracy reasons the * \f$z\f$ coordinates of the rotated points are set to zero * \see getNewellPlane() - * @param polygon_in a copy of the polygon_in polygon will be rotated - * @return vector of rotated points and normal based on the original Newell + * \param polygon_in a copy of the polygon_in polygon will be rotated + * \return vector of rotated points and normal based on the original Newell * plane */ std::tuple<std::vector<GeoLib::Point*>, Eigen::Vector3d> diff --git a/GeoLib/GEOObjects.h b/GeoLib/GEOObjects.h index 25ba0baade03ed314708d98fce53f76543ebf2cc..39eb3ea762a387a86e6c1b80853d345fca9c45b8 100644 --- a/GeoLib/GEOObjects.h +++ b/GeoLib/GEOObjects.h @@ -1,9 +1,9 @@ /** + * \file * \author Thomas Fischer / Karsten Rink * \date 2010-01-21 * \brief Definition of the GEOObjects class. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/GeoLib/IO/AsciiRasterInterface.cpp b/GeoLib/IO/AsciiRasterInterface.cpp index 9896dbef520fc4a3dcb0cfe0752eb442922f59ea..230575b25a4798a13f5e5ce5c77de3f1e2655622 100644 --- a/GeoLib/IO/AsciiRasterInterface.cpp +++ b/GeoLib/IO/AsciiRasterInterface.cpp @@ -1,10 +1,10 @@ /** - * @file AsciiRasterInterface.cpp - * @author Karsten Rink - * @date 2014-09-10 - * @brief Implementation of the AsciiRasterInterface class. + * \file + * \author Karsten Rink + * \date 2014-09-10 + * \brief Implementation of the AsciiRasterInterface class. * - * @copyright + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or diff --git a/GeoLib/IO/AsciiRasterInterface.h b/GeoLib/IO/AsciiRasterInterface.h index 612d1153fa5de744684137fdbcb2dabea4ee53bb..c4a604fc48148b73af46eb8d89f40e6631120881 100644 --- a/GeoLib/IO/AsciiRasterInterface.h +++ b/GeoLib/IO/AsciiRasterInterface.h @@ -1,10 +1,10 @@ /** - * @file AsciiRasterInterface.h - * @author Karsten Rink - * @date 2014-09-10 - * @brief Definition of the AsciiRasterInterface class. + * \file + * \author Karsten Rink + * \date 2014-09-10 + * \brief Definition of the AsciiRasterInterface class. * - * @copyright + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or diff --git a/GeoLib/IO/TINInterface.cpp b/GeoLib/IO/TINInterface.cpp index 9875a12a14afe1fc3a66335a8afa8893488a2743..368f0df1e536854c04eb7fef503a1449a67bbcd5 100644 --- a/GeoLib/IO/TINInterface.cpp +++ b/GeoLib/IO/TINInterface.cpp @@ -1,5 +1,6 @@ /** - * @copyright + * \file + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or diff --git a/GeoLib/IO/TINInterface.h b/GeoLib/IO/TINInterface.h index 8f16f8661b53062005aa2823bb75e84e9a7ecbc5..00351b30e93f4f797d8aff710190a42d8b165935 100644 --- a/GeoLib/IO/TINInterface.h +++ b/GeoLib/IO/TINInterface.h @@ -1,5 +1,6 @@ /** - * @copyright + * \file + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or @@ -29,10 +30,11 @@ class TINInterface public: /** * Reads TIN file - * @param fname TIN file name - * @param pnt_vec a point vector to which triangle vertices are added - * @param errors a vector of error messages - * @return a pointer to a GeoLib::Surface object created from TIN data. nullptr is returned if it fails to read the file. + * \param fname TIN file name + * \param pnt_vec a point vector to which triangle vertices are added + * \param errors a vector of error messages + * \return a pointer to a GeoLib::Surface object created from TIN data. + * nullptr is returned if it fails to read the file. */ static GeoLib::Surface* readTIN(std::string const& fname, GeoLib::PointVec &pnt_vec, @@ -40,8 +42,8 @@ public: /** * Writes surface data into TIN file - * @param surface surface object - * @param file_name TIN file name + * \param surface surface object + * \param file_name TIN file name */ static void writeSurfaceAsTIN(GeoLib::Surface const& surface, std::string const& file_name); }; diff --git a/GeoLib/OctTree-impl.h b/GeoLib/OctTree-impl.h index eaf5bbfca8d945d695ec76d5bd4b73ca12eaba4b..886fa38d1433248aa45c2876e3f2a04a3e42aa30 100644 --- a/GeoLib/OctTree-impl.h +++ b/GeoLib/OctTree-impl.h @@ -1,8 +1,8 @@ /** + * \file * \date 2015-06-12 * \brief Implementation of the OctTree class. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/GeoLib/Polygon.cpp b/GeoLib/Polygon.cpp index 138a798c09735fc0c288f9646e7c5c5c974ee381..583a8eb20b957f3080882310b616e718127c8610 100644 --- a/GeoLib/Polygon.cpp +++ b/GeoLib/Polygon.cpp @@ -48,10 +48,10 @@ enum class EdgeType * of the point relative to the line segment specified by the points source and * destination. (literature reference: * Computational Geometry and Computer Graphics in C++; Michael J. Laszlo) - * @param source the first point of the line segment - * @param destination the end point of the line segment - * @param pnt the test point - * @return a value of enum Location + * \param source the first point of the line segment + * \param destination the end point of the line segment + * \param pnt the test point + * \return a value of enum Location */ Location getLocationOfPoint(MathLib::Point3d const& source, MathLib::Point3d const& destination, @@ -95,10 +95,10 @@ Location getLocationOfPoint(MathLib::Point3d const& source, /** * from book: Computational Geometry and Computer Graphics in C++, page 119 * get the type of edge with respect to the given point (2d method!) - * @param a first point of line segment - * @param b last point of line segment - * @param pnt point that is edge type computed for - * @return a value of enum EdgeType + * \param a first point of line segment + * \param b last point of line segment + * \param pnt point that is edge type computed for + * \return a value of enum EdgeType */ EdgeType getEdgeType(MathLib::Point3d const& a, MathLib::Point3d const& b, @@ -183,9 +183,9 @@ bool Polygon::initialise() /** * Computes all intersections of the straight line segment and the polyline * boundary - * @param polygon the polygon the segment line segment that will be processed - * @param segment the line segment that will be processed - * @return a possible empty vector containing the intersection points + * \param polygon the polygon the segment line segment that will be processed + * \param segment the line segment that will be processed + * \return a possible empty vector containing the intersection points */ std::vector<GeoLib::Point> getAllIntersectionPoints( Polygon const& polygon, GeoLib::LineSegment const& segment) diff --git a/GeoLib/Polygon.h b/GeoLib/Polygon.h index 3c52fa5fd4f3b4bc3b30e40175a66bb3ae444d81..950adbf4b97312e269c94d5523c5bdf063780605 100644 --- a/GeoLib/Polygon.h +++ b/GeoLib/Polygon.h @@ -36,8 +36,8 @@ public: /** * constructor checks if the given polyline is closed, * and assures that the orientation is clock wise. - * @param ply closed Polyline - * @param init if true, check if polyline is closed, calculate bounding box + * \param ply closed Polyline + * \param init if true, check if polyline is closed, calculate bounding box */ explicit Polygon(const Polyline& ply, bool init = true); @@ -51,39 +51,43 @@ public: /** * Method checks if the given point is inside the polygon. * The method requires that the polygon has clock wise orientation. - * @param pnt the Point - * @return if point is inside the polygon true, else false + * \param pnt the Point + * \return if point is inside the polygon true, else false */ bool isPntInPolygon(MathLib::Point3d const& pnt) const; /** * Checks if the straight line segment is contained within the polygon. - * @param segment the straight line segment that is checked with - * @return true if the straight line segment is within the polygon, else false + * \param segment the straight line segment that is checked with + * \return true if the straight line segment is within the polygon, else + * false */ bool containsSegment(GeoLib::LineSegment const& segment) const; /** - * Method checks if all points of the polyline ply are inside of the polygon. - * @param ply the polyline that should be checked + * Method checks if all points of the polyline ply are inside of the + * polygon. + * \param ply the polyline that should be checked */ bool isPolylineInPolygon (const Polyline& ply) const; /** - * Method checks first if at least one (end!) point of a line segment of the polyline - * is inside of the polygon. If this test fails each line segment of the polyline will - * be tested against each polygon segment for intersection. - * @param ply the polyline that should be checked - * @return true if a part of the polyline is within the polygon + * Method checks first if at least one (end!) point of a line segment of the + * polyline is inside of the polygon. If this test fails each line segment + * of the polyline will be tested against each polygon segment for + * intersection. + * \param ply the polyline that should be checked + * \return true if a part of the polyline is within the polygon */ bool isPartOfPolylineInPolygon (const Polyline& ply) const; /** * Calculates the next intersection point between the line segment \c seg * and the polygon starting with segment \c seg_num. - * @param seg (input) Line segment to compute intersection. - * @param intersection_pnt (output) next intersection point - * @param seg_num (in/out) the number of the polygon segment that is intersecting - * @return true, if there was an intersection, i.e., the \c intersection_pnt + * \param seg (input) Line segment to compute intersection. + * \param intersection_pnt (output) next intersection point + * \param seg_num (in/out) the number of the polygon segment that is + * intersecting + * \return true, if there was an intersection, i.e., the \c intersection_pnt * and \c seg_num contains new valid values */ bool getNextIntersectionPointPolygonLine(GeoLib::LineSegment const& seg, @@ -108,9 +112,9 @@ private: /** * comparison operator for polygons - * @param lhs the first polygon - * @param rhs the second polygon - * @return true, if the polygons describe the same geometrical object + * \param lhs the first polygon + * \param rhs the second polygon + * \return true, if the polygons describe the same geometrical object */ bool operator==(Polygon const& lhs, Polygon const& rhs); diff --git a/GeoLib/Polyline.h b/GeoLib/Polyline.h index 2968639857145a719772e899c87db650e2bb1f7b..214245890b867ffab88fbc0ca7b5ea5bae48c483 100644 --- a/GeoLib/Polyline.h +++ b/GeoLib/Polyline.h @@ -92,7 +92,7 @@ public: explicit Polyline(const std::vector<Point*>& pnt_vec); /** * Copy constructor - * @param ply Polyline + * \param ply Polyline */ Polyline(const Polyline& ply); Polyline& operator=(Polyline const& other) = delete; @@ -106,7 +106,7 @@ public: * Adds an id of a point at the end of the polyline if and only if the * resulting segment won't be empty. The id have to be inside the (internal) * \c _ply_pnts vector the polyline is based on. - * @return If the point could be added the return value is \c true. If the + * \return If the point could be added the return value is \c true. If the * addition of the point would result in empty line segment \c false is * returned. */ @@ -116,19 +116,19 @@ public: * Method inserts a new point (that have to be inside the _ply_pnts vector) * at the given position in the polyline if and only if the resulting * segments won't be empty. - * @param pos the position in the polyline, pos have to be a value into the + * \param pos the position in the polyline, pos have to be a value into the * interval [0, number of points) - * @param pnt_id the id of the new point in the vector of points the + * \param pnt_id the id of the new point in the vector of points the * polyline is based on - * @return true if the point could be inserted, else false (if empty line + * \return true if the point could be inserted, else false (if empty line * segments would be created). */ virtual bool insertPoint(std::size_t pos, std::size_t pnt_id); /** - * Method removes a point from the polyline. The connecting line segments will - * be removed and the length of the polyline will be changed. - * @param pos a valid position within the polyline + * Method removes a point from the polyline. The connecting line segments + * will be removed and the length of the polyline will be changed. + * \param pos a valid position within the polyline */ void removePoint(std::size_t pos); @@ -157,10 +157,10 @@ public: bool isCoplanar() const; /** - * Method tests if the given id of a point (within the vector of points the polyline is - * based on) is inside the polyline. - * @param pnt_id the id of the point - * @return true if the point is part of the polyline, else false + * Method tests if the given id of a point (within the vector of points the + * polyline is based on) is inside the polyline. + * \param pnt_id the id of the point + * \return true if the point is part of the polyline, else false */ bool isPointIDInPolyline(std::size_t pnt_id) const; @@ -172,8 +172,8 @@ public: /** * Changes a point index for one point in a line - * @param idx Index of point in line - * @param id ID of point in PointVec object + * \param idx Index of point in line + * \param id ID of point in PointVec object */ void setPointID(std::size_t idx, std::size_t id); @@ -195,11 +195,13 @@ public: std::vector<Point*> const& getPointsVec () const; /** - * returns the distance along the polyline from the beginning of the polyline - * @param pnt the point on the polyline - * @param epsilon_radius the epsilon - * @return the distance along the polyline between the given point and the beginning of the polyline. - * If the given point is not on the polyine, negative value is returned. + * returns the distance along the polyline from the beginning of the + * polyline + * \param pnt the point on the polyline + * \param epsilon_radius the epsilon + * \return the distance along the polyline between the given point and the + * beginning of the polyline. If the given point is not on the + * polyine, negative value is returned. */ double getDistanceAlongPolyline(const MathLib::Point3d& pnt, const double epsilon_radius) const; @@ -227,9 +229,9 @@ bool containsEdge (const Polyline& ply, std::size_t id0, std::size_t id1); /** * comparison operator - * @param lhs first polyline - * @param rhs second polyline - * @return true, if the polylines consists of the same sequence of line segments + * \param lhs first polyline + * \param rhs second polyline + * \return true, if the polylines consists of the same sequence of line segments */ bool operator==(Polyline const& lhs, Polyline const& rhs); diff --git a/GeoLib/Raster.cpp b/GeoLib/Raster.cpp index 997dbb9b4d0ab11f8b493cbeea2197a5d81e6b84..f7f5cc7ebad4e14c44e2c39fdb9e23204176dbd0 100644 --- a/GeoLib/Raster.cpp +++ b/GeoLib/Raster.cpp @@ -1,10 +1,10 @@ /** - * @file Raster.cpp - * @author Thomas Fischer - * @date 2011-09-07 - * @brief Implementation of the GeoLib::Raster class. + * \file + * \author Thomas Fischer + * \date 2011-09-07 + * \brief Implementation of the GeoLib::Raster class. * - * @copyright + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or diff --git a/GeoLib/Raster.h b/GeoLib/Raster.h index 6f7aa3c0b767dd6fd512fa0353c1348803058d23..50035193d7e4a285da62e6dce317b06564ab10b5 100644 --- a/GeoLib/Raster.h +++ b/GeoLib/Raster.h @@ -1,10 +1,10 @@ /** - * @file Raster.h - * @author Thomas Fischer - * @date 2011-09-07 - * @brief Definition of the GeoLib::Raster class. + * \file + * \author Thomas Fischer + * \date 2011-09-07 + * \brief Definition of the GeoLib::Raster class. * - * @copyright + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or @@ -36,7 +36,7 @@ struct RasterHeader final }; /** - * @brief Class Raster is used for managing raster data. + * \brief Class Raster is used for managing raster data. * * A raster consists of the meta data like number of columns and rows, the * lower left point, the size of a raster pixel and a value for invalid data @@ -48,13 +48,13 @@ class Raster final { public: /** - * @brief Constructor for an object of class Raster. The raster data + * \brief Constructor for an object of class Raster. The raster data * have to be handed over via input iterators. Deploying iterators has * the advantage that the use of the class is independent from the input * container. - * @param header meta-information about the raster (height, width, etc.) - * @param begin input iterator pointing to the first element of the data - * @param end input iterator pointing to the last element of the data, + * \param header meta-information about the raster (height, width, etc.) + * \param begin input iterator pointing to the first element of the data + * \param end input iterator pointing to the last element of the data, * end have to be reachable from begin */ template <typename InputIterator> @@ -90,7 +90,7 @@ public: /** * Constant iterator that is pointing to the first raster pixel value. - * @return constant iterator + * \return constant iterator */ std::vector<double>::const_iterator begin() const { @@ -100,7 +100,7 @@ public: /** * Iterator to the element following the last pixel element of the * raster - * @return constant iterator + * \return constant iterator */ std::vector<double>::const_iterator end() const { diff --git a/GeoLib/SurfaceGrid.cpp b/GeoLib/SurfaceGrid.cpp index 7b0dc2fde566ac30b61ecdf0c68dc4a4cd25d4a5..bb5c0f9403f28a26dffd58344c30039ea50aac9d 100644 --- a/GeoLib/SurfaceGrid.cpp +++ b/GeoLib/SurfaceGrid.cpp @@ -1,8 +1,8 @@ /* + * \file * \date 2012-09-22 * \brief Definition of the SurfaceGrid class. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/GeoLib/SurfaceGrid.h b/GeoLib/SurfaceGrid.h index dca3415a98311580032fa3c326064a975419e040..319341cce83a46a94a7620c1dba2c885fd9cfc5c 100644 --- a/GeoLib/SurfaceGrid.h +++ b/GeoLib/SurfaceGrid.h @@ -1,8 +1,8 @@ /* + * \file * \date 2012-09-22 * \brief Declaration of the SurfaceGrid class. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/GeoLib/TemplateVec.h b/GeoLib/TemplateVec.h index c81ddc2d347e7385ba7991079c3430c1e01b9b35..d992719206e3f41993c2a05db9e545f8e45d51c3 100644 --- a/GeoLib/TemplateVec.h +++ b/GeoLib/TemplateVec.h @@ -1,10 +1,10 @@ /** - * @file TemplateVec.h - * @date 2010-02-26 - * @author Thomas Fischer - * @brief Definition of the GeoLib::TemplateVec class. + * \file + * \date 2010-02-26 + * \author Thomas Fischer + * \brief Definition of the GeoLib::TemplateVec class. * - * @copyright + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or @@ -45,13 +45,13 @@ public: /** * Constructor of class TemlateVec. - * @param name unique name of the project the elements belonging to. + * \param name unique name of the project the elements belonging to. * In order to access the data elements a unique name is required. - * @param data_vec Vector of data elements. - * @attention{TemplateVec will take the ownership of the vector + * \param data_vec Vector of data elements. + * \attention{TemplateVec will take the ownership of the vector * and also its elements, * i.e. delete its elements and delete the vector itself!} - * @param elem_name_map Names of data elements can be given by a + * \param elem_name_map Names of data elements can be given by a * std::map<std::string, std::size_t>. Here the std::string is the name * of the element and the value for std::size_t stands for an index in * the data_vec. @@ -81,7 +81,7 @@ public: void setName(const std::string& n) { _name = n; } /** * the name, the data element belonging to - * @return the name of the object + * \return the name of the object */ std::string getName() const { return _name; } @@ -98,21 +98,21 @@ public: } /** - * @return the number of data elements + * \return the number of data elements */ std::size_t size() const { return _data_vec.size(); } /** * get a pointer to a standard vector containing the data elements - * @return the data elements + * \return the data elements */ std::vector<T*> const& getVector() const { return _data_vec; } /** * search the vector of names for the ID of the geometric element with the * given name - * @param name the name of the geometric element - * @param id the id of the geometric element + * \param name the name of the geometric element + * \param id the id of the geometric element */ bool getElementIDByName(const std::string& name, std::size_t& id) const { @@ -142,10 +142,10 @@ public: /** * The method returns true if there is a name associated * with the given id, else method returns false. - * @param id the id - * @param element_name if a name associated with the id + * \param id the id + * \param element_name if a name associated with the id * is found name is assigned to element_name - * @return if there is name associated with the given id: + * \return if there is name associated with the given id: * true, else false */ bool getNameOfElementByID(std::size_t id, std::string& element_name) const @@ -169,10 +169,10 @@ public: /** * The method returns true if the given element of type T * can be found and the element has a name, else method returns false. - * @param data the data element, one wants to know the name - * @param name the name of the data element (if the data element is + * \param data the data element, one wants to know the name + * \param name the name of the data element (if the data element is * found and the data element has a name) - * @return if element is found and has a name: true, else false + * \return if element is found and has a name: true, else false */ bool getNameOfElement(const T* data, std::string& name) const { diff --git a/InfoLib/CMakeInfo.cpp.in b/InfoLib/CMakeInfo.cpp.in index dbb79409185218108e96b93db75b4cf238626712..c60ed6031862f0c2aa6b885e432df4cbd3912a28 100644 --- a/InfoLib/CMakeInfo.cpp.in +++ b/InfoLib/CMakeInfo.cpp.in @@ -1,7 +1,7 @@ /** + * \file * \brief CMake information. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/InfoLib/CMakeInfo.h b/InfoLib/CMakeInfo.h index d16f19d4e4fe38069df3a02958ef7c572395de80..cb508fa774b25377ff25478713fd9723beb7df19 100644 --- a/InfoLib/CMakeInfo.h +++ b/InfoLib/CMakeInfo.h @@ -1,7 +1,7 @@ /** + * \file * \brief CMake information. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/InfoLib/GitInfo.cpp.in b/InfoLib/GitInfo.cpp.in index 44bdc93d6d7bbbf4003839392665c52732b2cdfe..f3870f1f374f3c8d09102034fec5e1737a437ddc 100644 --- a/InfoLib/GitInfo.cpp.in +++ b/InfoLib/GitInfo.cpp.in @@ -1,7 +1,7 @@ /** + * \file * \brief Git information. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/InfoLib/GitInfo.h b/InfoLib/GitInfo.h index a63dbaa630f79bb58050bfca215e502d810b465a..37ed6e2a9aa77c305ba8e435b9a4973c6cc302c0 100644 --- a/InfoLib/GitInfo.h +++ b/InfoLib/GitInfo.h @@ -1,7 +1,7 @@ /** + * \file * \brief Git information. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/InfoLib/TestInfo.cpp.in b/InfoLib/TestInfo.cpp.in index e4e3dd27938530b30321ecd028367e9236cf7e81..95726dc65f36529b4d52a2123539d080d3e71c7a 100644 --- a/InfoLib/TestInfo.cpp.in +++ b/InfoLib/TestInfo.cpp.in @@ -1,7 +1,7 @@ /** + * \file * \brief Test information. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/InfoLib/TestInfo.h b/InfoLib/TestInfo.h index 02b3dd2551e05663b4030f5c8a890f731cb09e43..1efb8f144d3d21f694934b08072e418eba827608 100644 --- a/InfoLib/TestInfo.h +++ b/InfoLib/TestInfo.h @@ -1,7 +1,7 @@ /** + * \file * \brief Test information. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MaterialLib/Fluid/ConstantFluidProperty.h b/MaterialLib/Fluid/ConstantFluidProperty.h index 0fa72a6bea1660a03b426e692247bd5620c21a54..ec195ac9fa2cab7dfbdcb8d9d472f62bc5815157 100644 --- a/MaterialLib/Fluid/ConstantFluidProperty.h +++ b/MaterialLib/Fluid/ConstantFluidProperty.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 15, 2016, 12:11 PM */ diff --git a/MaterialLib/Fluid/Density/LinearConcentrationAndPressureDependentDensity.h b/MaterialLib/Fluid/Density/LinearConcentrationAndPressureDependentDensity.h index a1be1b08e26984ed612816147113642ec310656b..694538d998925808e79211e4f3fc6e4b96ba010d 100644 --- a/MaterialLib/Fluid/Density/LinearConcentrationAndPressureDependentDensity.h +++ b/MaterialLib/Fluid/Density/LinearConcentrationAndPressureDependentDensity.h @@ -1,5 +1,6 @@ /** - * @copyright + * \file + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or @@ -31,12 +32,12 @@ class LinearConcentrationAndPressureDependentDensity final { public: /** - * @param reference_density \f$\rho_0\f$ - * @param reference_concentration \f$C_0\f$ - * @param fluid_density_concentration_difference_ratio \f$ \bar \alpha \f$ + * \param reference_density \f$\rho_0\f$ + * \param reference_concentration \f$C_0\f$ + * \param fluid_density_concentration_difference_ratio \f$ \bar \alpha \f$ * in reference - * @param reference_pressure \f$p_0\f$ - * @param fluid_density_pressure_difference_ratio \f$ \bar \beta \f$ in + * \param reference_pressure \f$p_0\f$ + * \param fluid_density_pressure_difference_ratio \f$ \bar \beta \f$ in * reference Coupled groundwater flow and transport: 2. Thermohaline and 3D * convection systems */ diff --git a/MaterialLib/Fluid/Density/LinearConcentrationDependentDensity.h b/MaterialLib/Fluid/Density/LinearConcentrationDependentDensity.h index e8b09fb445bc4c2899def57fe7324be1ed5854e1..053a822c6439f0ba30c53a9752a4a11051d02e56 100644 --- a/MaterialLib/Fluid/Density/LinearConcentrationDependentDensity.h +++ b/MaterialLib/Fluid/Density/LinearConcentrationDependentDensity.h @@ -1,5 +1,6 @@ /** - * @copyright + * \file + * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or @@ -28,9 +29,9 @@ class LinearConcentrationDependentDensity final : public FluidProperty { public: /** - * @param reference_density \f$\rho_0\f$ - * @param reference_concentration \f$C_0\f$ - * @param fluid_density_difference_ratio \f$ \bar \alpha \f$ in reference + * \param reference_density \f$\rho_0\f$ + * \param reference_concentration \f$C_0\f$ + * \param fluid_density_difference_ratio \f$ \bar \alpha \f$ in reference * Coupled groundwater flow and transport: 2. Thermohaline and 3D convection * systems */ diff --git a/MaterialLib/Fluid/Density/LinearTemperatureDependentDensity.h b/MaterialLib/Fluid/Density/LinearTemperatureDependentDensity.h index 854c03117985363428b1c43fd48035c15944eaf4..0883ea7b1d90d7933c54dd5fe48e9efdde804a3e 100644 --- a/MaterialLib/Fluid/Density/LinearTemperatureDependentDensity.h +++ b/MaterialLib/Fluid/Density/LinearTemperatureDependentDensity.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * \author: wenqing * * Created on August 10, 2016, 11:34 AM diff --git a/MaterialLib/Fluid/Density/LiquidDensity.h b/MaterialLib/Fluid/Density/LiquidDensity.h index 0305ce5cc6b4b006724e49937ae1bb10c97d6ca1..aa3494028c2624d15d79a5935153245009bd9964 100644 --- a/MaterialLib/Fluid/Density/LiquidDensity.h +++ b/MaterialLib/Fluid/Density/LiquidDensity.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. @@ -6,7 +7,6 @@ * http://www.opengeosys.org/project/license * * \author wenqing - * \file * * Created on August 4, 2016, 10:15 AM */ diff --git a/MaterialLib/Fluid/FluidProperties/CreateFluidProperties.cpp b/MaterialLib/Fluid/FluidProperties/CreateFluidProperties.cpp index 78c6007ccde51bc11db6bceff0e1de97be00180d..24ed2159659d5cf318f41be5b09881e0e88b96f7 100644 --- a/MaterialLib/Fluid/FluidProperties/CreateFluidProperties.cpp +++ b/MaterialLib/Fluid/FluidProperties/CreateFluidProperties.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on December 13, 2016, 3:32 PM */ diff --git a/MaterialLib/Fluid/FluidProperties/CreateFluidProperties.h b/MaterialLib/Fluid/FluidProperties/CreateFluidProperties.h index 266d6a8842c698ad7b6ef84dbe2a224392190d22..994180a8373890dbf66e42612d52a2d81faac741 100644 --- a/MaterialLib/Fluid/FluidProperties/CreateFluidProperties.h +++ b/MaterialLib/Fluid/FluidProperties/CreateFluidProperties.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on December 13, 2016, 3:32 PM */ diff --git a/MaterialLib/Fluid/FluidProperties/FluidProperties.h b/MaterialLib/Fluid/FluidProperties/FluidProperties.h index a3f89f61e6a2f156d91dbee1c83a609d20f8a81a..f540bde871e942cf8a4c576b36162367ed55c426 100644 --- a/MaterialLib/Fluid/FluidProperties/FluidProperties.h +++ b/MaterialLib/Fluid/FluidProperties/FluidProperties.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 29, 2016, 2:23 PM */ diff --git a/MaterialLib/Fluid/FluidProperties/FluidPropertiesWithDensityDependentModels.cpp b/MaterialLib/Fluid/FluidProperties/FluidPropertiesWithDensityDependentModels.cpp index 4344901a6e11aa2aecd80424e5e406b1fa4616e0..f280f2b69fa76184d085f8a369f447aac9aec70e 100644 --- a/MaterialLib/Fluid/FluidProperties/FluidPropertiesWithDensityDependentModels.cpp +++ b/MaterialLib/Fluid/FluidProperties/FluidPropertiesWithDensityDependentModels.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 29, 2016, 3:19 PM */ diff --git a/MaterialLib/Fluid/FluidProperties/FluidPropertiesWithDensityDependentModels.h b/MaterialLib/Fluid/FluidProperties/FluidPropertiesWithDensityDependentModels.h index 4dd08aa747a5b43fc8f07c996168afcd3f86453a..0620572dce08dc2a98cea912e4d5d8e8d1e0165b 100644 --- a/MaterialLib/Fluid/FluidProperties/FluidPropertiesWithDensityDependentModels.h +++ b/MaterialLib/Fluid/FluidProperties/FluidPropertiesWithDensityDependentModels.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 29, 2016, 4:18 PM */ diff --git a/MaterialLib/Fluid/FluidProperties/PrimaryVariableDependentFluidProperties.h b/MaterialLib/Fluid/FluidProperties/PrimaryVariableDependentFluidProperties.h index af8f7c1e510f5624b67d95cc07deed306d2f4c03..135e8736af0ff2d2ff2052174408e13639cdbb97 100644 --- a/MaterialLib/Fluid/FluidProperties/PrimaryVariableDependentFluidProperties.h +++ b/MaterialLib/Fluid/FluidProperties/PrimaryVariableDependentFluidProperties.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 29, 2016, 3:19 PM */ diff --git a/MaterialLib/Fluid/FluidProperty.h b/MaterialLib/Fluid/FluidProperty.h index 3d1732f3723cc9c7940b3cf2dcff60cb4f62132f..631525820f5846d9cec1135d3f9f11da5212ff3a 100644 --- a/MaterialLib/Fluid/FluidProperty.h +++ b/MaterialLib/Fluid/FluidProperty.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 12, 2016, 3:34 PM */ diff --git a/MaterialLib/Fluid/GibbsFreeEnergy/DimensionLessGibbsFreeEnergyRegion1.cpp b/MaterialLib/Fluid/GibbsFreeEnergy/DimensionLessGibbsFreeEnergyRegion1.cpp index 0f73e2541fe44c2fd33039ae3950fccabab02d0c..ca34154a4f57774c3961341786e7fefbb2098d55 100644 --- a/MaterialLib/Fluid/GibbsFreeEnergy/DimensionLessGibbsFreeEnergyRegion1.cpp +++ b/MaterialLib/Fluid/GibbsFreeEnergy/DimensionLessGibbsFreeEnergyRegion1.cpp @@ -1,4 +1,5 @@ /** + * \file * \brief Define members of the class for dimensionless Gibbs free energy. * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on December 8, 2016, 12:31 PM */ diff --git a/MaterialLib/Fluid/GibbsFreeEnergy/DimensionLessGibbsFreeEnergyRegion1.h b/MaterialLib/Fluid/GibbsFreeEnergy/DimensionLessGibbsFreeEnergyRegion1.h index 5ba811a2a7110578cdb29bfb7b6d26668dc27ac7..8b033d134455a98a996378e9c26b2ead2449fc7a 100644 --- a/MaterialLib/Fluid/GibbsFreeEnergy/DimensionLessGibbsFreeEnergyRegion1.h +++ b/MaterialLib/Fluid/GibbsFreeEnergy/DimensionLessGibbsFreeEnergyRegion1.h @@ -1,4 +1,5 @@ /** + * \file * \brief Declare a class for dimensionless Gibbs free energy, region1. * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on December 8, 2016, 12:31 PM */ diff --git a/MaterialLib/Fluid/GibbsFreeEnergy/DimensionlessGibbsFreeEnergyRegion2.h b/MaterialLib/Fluid/GibbsFreeEnergy/DimensionlessGibbsFreeEnergyRegion2.h index 4827948b0454b6e90a068d615b13a1313220db7c..ff8263ad9a656c3a2eca8069411999898903c078 100644 --- a/MaterialLib/Fluid/GibbsFreeEnergy/DimensionlessGibbsFreeEnergyRegion2.h +++ b/MaterialLib/Fluid/GibbsFreeEnergy/DimensionlessGibbsFreeEnergyRegion2.h @@ -20,8 +20,8 @@ namespace Fluid namespace DimensionlessGibbsFreeEnergyRegion2 { /** - * @param pi Dimensionless temperature - * @param tau Dimensionless pressure + * \param pi Dimensionless temperature + * \param tau Dimensionless pressure */ double getGamma(const double tau, const double pi); diff --git a/MaterialLib/Fluid/PropertyVariableType.h b/MaterialLib/Fluid/PropertyVariableType.h index a1091120856cc78dd3aa9d87f1dfe4c8f0ff648f..1debc8b0d14aff224144fcaf1fe23c3429e9f823 100644 --- a/MaterialLib/Fluid/PropertyVariableType.h +++ b/MaterialLib/Fluid/PropertyVariableType.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 29, 2016, 2:28 PM */ diff --git a/MaterialLib/Fluid/SpecificHeatCapacity/CreateSpecificFluidHeatCapacityModel.cpp b/MaterialLib/Fluid/SpecificHeatCapacity/CreateSpecificFluidHeatCapacityModel.cpp index d04a09a251b8b6741592eb406363b64a641b8460..5278347e0d6f60c64b7443a771ba8f96fd8655a9 100644 --- a/MaterialLib/Fluid/SpecificHeatCapacity/CreateSpecificFluidHeatCapacityModel.cpp +++ b/MaterialLib/Fluid/SpecificHeatCapacity/CreateSpecificFluidHeatCapacityModel.cpp @@ -1,4 +1,5 @@ /** + * \file * \brief A function for creating a specific heat capacity model for fluid * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #include "CreateSpecificFluidHeatCapacityModel.h" diff --git a/MaterialLib/Fluid/SpecificHeatCapacity/CreateSpecificFluidHeatCapacityModel.h b/MaterialLib/Fluid/SpecificHeatCapacity/CreateSpecificFluidHeatCapacityModel.h index 94747ae77fd79af7c231b07954f32e86eedec9db..94864e9aeb0e4240ff01ad373778bd4ac08b1dca 100644 --- a/MaterialLib/Fluid/SpecificHeatCapacity/CreateSpecificFluidHeatCapacityModel.h +++ b/MaterialLib/Fluid/SpecificHeatCapacity/CreateSpecificFluidHeatCapacityModel.h @@ -1,4 +1,5 @@ /** + * \file * \brief A function for creating a specific heat capacity model for fluid * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #pragma once diff --git a/MaterialLib/Fluid/ThermalConductivity/CreateFluidThermalConductivityModel.cpp b/MaterialLib/Fluid/ThermalConductivity/CreateFluidThermalConductivityModel.cpp index d34a292e5ddd70e49ff09c5afeda845a5f9d80a3..52f444a7d482e06845569d0254a52c809c02066d 100644 --- a/MaterialLib/Fluid/ThermalConductivity/CreateFluidThermalConductivityModel.cpp +++ b/MaterialLib/Fluid/ThermalConductivity/CreateFluidThermalConductivityModel.cpp @@ -1,4 +1,5 @@ /** + * \file * \brief A function for creating a thermal conductivity model for fluid * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #include "CreateFluidThermalConductivityModel.h" diff --git a/MaterialLib/Fluid/ThermalConductivity/CreateFluidThermalConductivityModel.h b/MaterialLib/Fluid/ThermalConductivity/CreateFluidThermalConductivityModel.h index ab405422ad76da07171c837d0930079a058aefbb..e4399c55bc020917479ae9c50c1f854048e8b2f2 100644 --- a/MaterialLib/Fluid/ThermalConductivity/CreateFluidThermalConductivityModel.h +++ b/MaterialLib/Fluid/ThermalConductivity/CreateFluidThermalConductivityModel.h @@ -1,4 +1,5 @@ /** + * \file * \brief A function for creating a thermal conductivity model for fluid * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #pragma once diff --git a/MaterialLib/Fluid/Viscosity/CreateViscosityModel.cpp b/MaterialLib/Fluid/Viscosity/CreateViscosityModel.cpp index 5ddc70e2e682719c3d7e74815a6216a2ab102aba..260a3d6272afc4c6a30fb6406ea67d712589ea9a 100644 --- a/MaterialLib/Fluid/Viscosity/CreateViscosityModel.cpp +++ b/MaterialLib/Fluid/Viscosity/CreateViscosityModel.cpp @@ -1,4 +1,5 @@ /** + * \file * \brief A function for creating viscosity model * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #include "CreateViscosityModel.h" diff --git a/MaterialLib/Fluid/Viscosity/CreateViscosityModel.h b/MaterialLib/Fluid/Viscosity/CreateViscosityModel.h index 38d327acc1997f19aae386c8bf540d3f69b46342..e55959439e30061e65a9351d6228efa63ec39e88 100644 --- a/MaterialLib/Fluid/Viscosity/CreateViscosityModel.h +++ b/MaterialLib/Fluid/Viscosity/CreateViscosityModel.h @@ -1,4 +1,5 @@ /** + * \file * \brief A function for creating viscosity model * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #pragma once diff --git a/MaterialLib/Fluid/Viscosity/LinearPressureDependentViscosity.h b/MaterialLib/Fluid/Viscosity/LinearPressureDependentViscosity.h index 611f3813be8f2fefc1eef17abd065cfbd670aaf9..bf47d474ebd4f936e1fa6994d0eb7bf194a8ab54 100644 --- a/MaterialLib/Fluid/Viscosity/LinearPressureDependentViscosity.h +++ b/MaterialLib/Fluid/Viscosity/LinearPressureDependentViscosity.h @@ -1,4 +1,5 @@ /** + * \file * \brief Declaration of class for the pressure dependent viscosity model. * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #pragma once diff --git a/MaterialLib/Fluid/Viscosity/TemperatureDependentViscosity.h b/MaterialLib/Fluid/Viscosity/TemperatureDependentViscosity.h index 6c1d20849f12adf06f1e52f2617da1fcf2c482b2..66a58323dc12cae6f189b871eed186f8fa0b818d 100644 --- a/MaterialLib/Fluid/Viscosity/TemperatureDependentViscosity.h +++ b/MaterialLib/Fluid/Viscosity/TemperatureDependentViscosity.h @@ -1,4 +1,5 @@ /** + * \file * \brief A linear temperature dependent viscosity model. * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 10, 2016, 10:45 AM */ diff --git a/MaterialLib/Fluid/Viscosity/VogelsLiquidDynamicViscosity.h b/MaterialLib/Fluid/Viscosity/VogelsLiquidDynamicViscosity.h index 635f65e0dfe2e4f0d3a629d2529871f181c52b6e..7fda8cd38e170bd8167ce4725d7510f80ccad030 100644 --- a/MaterialLib/Fluid/Viscosity/VogelsLiquidDynamicViscosity.h +++ b/MaterialLib/Fluid/Viscosity/VogelsLiquidDynamicViscosity.h @@ -1,4 +1,5 @@ /** + * \file * \brief Declaration of class for the pressure dependent viscosity model. * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #pragma once diff --git a/MaterialLib/Fluid/WaterVaporProperties/WaterVaporProperties.cpp b/MaterialLib/Fluid/WaterVaporProperties/WaterVaporProperties.cpp index f540874b769cefb7d37ccab1b67f6c382f6aa8a9..3f0b0f3cc4172c0347b5d261eb4c2ee9d2df5506 100644 --- a/MaterialLib/Fluid/WaterVaporProperties/WaterVaporProperties.cpp +++ b/MaterialLib/Fluid/WaterVaporProperties/WaterVaporProperties.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #include "WaterVaporProperties.h" diff --git a/MaterialLib/Fluid/WaterVaporProperties/WaterVaporProperties.h b/MaterialLib/Fluid/WaterVaporProperties/WaterVaporProperties.h index 8d39d6a9518b86af2f1f2afab88a78a0a075e2fb..09276c7d2ba6293a3c9738657f9b72c762b6de2e 100644 --- a/MaterialLib/Fluid/WaterVaporProperties/WaterVaporProperties.h +++ b/MaterialLib/Fluid/WaterVaporProperties/WaterVaporProperties.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #pragma once diff --git a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationBrooksCorey.cpp b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationBrooksCorey.cpp index 65e027a44b4d4111e4f3a8dc9468fe14ca8d4557..2984143ef706374251b028f3693b8b1b6f07f975 100644 --- a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationBrooksCorey.cpp +++ b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationBrooksCorey.cpp @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationBrooksCorey.h b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationBrooksCorey.h index 5b5a97a79a3c9257101a7534eb9656c51f711b67..e74cb983b519edf614822d8821e1fa25165ad072 100644 --- a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationBrooksCorey.h +++ b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationBrooksCorey.h @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.cpp b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.cpp index 954ffe7b8a7b21d05e9665ddd96e9f071cf2ef68..a15b684e55fa883d4bfe6ea855155f20b8dfc1f8 100644 --- a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.cpp +++ b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.cpp @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.h b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.h index d9719bdd2ceb9d2f10708ec6efd4a9697d4711a9..acdc7b76da210de4e7c7943bc15b8e64071a5755 100644 --- a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.h +++ b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationExponential.h @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationLiakopoulos.cpp b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationLiakopoulos.cpp index 74e797d28bc73072d587accf3d17c4e0c184970c..55a202dd5e8b88135702e6a25b59f9deaebc54ef 100644 --- a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationLiakopoulos.cpp +++ b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationLiakopoulos.cpp @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationLiakopoulos.h b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationLiakopoulos.h index 0ac04dcb15a5d9192b9a6b7bf2258dcfa1b492bc..31b3f45331c959c184dc5824add0d2f6081df174 100644 --- a/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationLiakopoulos.h +++ b/MaterialLib/MPL/Properties/CapillaryPressureSaturation/SaturationLiakopoulos.h @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/ClausiusClapeyron.cpp b/MaterialLib/MPL/Properties/ClausiusClapeyron.cpp index c65aa2c2eb618d1b8fc1ebbb563baa5e46152636..86af9b286d523dfe3710e86e846c1f6787de45d8 100644 --- a/MaterialLib/MPL/Properties/ClausiusClapeyron.cpp +++ b/MaterialLib/MPL/Properties/ClausiusClapeyron.cpp @@ -2,9 +2,7 @@ * \file * \author Norbert Grunwald * \date Dec 07, 2020 - * \brief * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MaterialLib/MPL/Properties/IdealGasLaw.cpp b/MaterialLib/MPL/Properties/IdealGasLaw.cpp index 8f7bd3bc13376d776ce97937edeaf4792a07c724..b6c641472470a58c9bf960a3818563da788b8667 100644 --- a/MaterialLib/MPL/Properties/IdealGasLaw.cpp +++ b/MaterialLib/MPL/Properties/IdealGasLaw.cpp @@ -2,9 +2,7 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MaterialLib/MPL/Properties/IdealGasLaw.h b/MaterialLib/MPL/Properties/IdealGasLaw.h index 6395a42f9b8eba7d0ceb934d94e43d12deaaa426..06c763a7752fcdd49491fd64d5a2cb07ce4047d5 100644 --- a/MaterialLib/MPL/Properties/IdealGasLaw.h +++ b/MaterialLib/MPL/Properties/IdealGasLaw.h @@ -2,9 +2,7 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MaterialLib/MPL/Properties/IdealGasLawBinaryMixture.cpp b/MaterialLib/MPL/Properties/IdealGasLawBinaryMixture.cpp index 401a13dd722ab345e34783a7372f548f5deb956b..0303507e671128341f8634a632d31346e662421a 100644 --- a/MaterialLib/MPL/Properties/IdealGasLawBinaryMixture.cpp +++ b/MaterialLib/MPL/Properties/IdealGasLawBinaryMixture.cpp @@ -2,9 +2,7 @@ * \file * \author Norbert Grunwald * \date Jan, 2021 - * \brief * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MaterialLib/MPL/Properties/IdealGasLawBinaryMixture.h b/MaterialLib/MPL/Properties/IdealGasLawBinaryMixture.h index 8c618638b19a657b36ccb2ebadd8ae4624bd4da9..29bbbae68301747a60c30656cf6b5f377474eb00 100644 --- a/MaterialLib/MPL/Properties/IdealGasLawBinaryMixture.h +++ b/MaterialLib/MPL/Properties/IdealGasLawBinaryMixture.h @@ -2,9 +2,7 @@ * \file * \author Norbert Grunwald * \date Jan, 2021 - * \brief * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MaterialLib/MPL/Properties/PermeabilityOrthotropicPowerLaw.h b/MaterialLib/MPL/Properties/PermeabilityOrthotropicPowerLaw.h index 54220d01953e256a381adc9e09e51af373dde1de..0840ac54cd479cbc24b89160dc16908b4c98c68c 100644 --- a/MaterialLib/MPL/Properties/PermeabilityOrthotropicPowerLaw.h +++ b/MaterialLib/MPL/Properties/PermeabilityOrthotropicPowerLaw.h @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCorey.cpp b/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCorey.cpp index fa1fe39508d5d00a13428033dc591082a7dafd25..bbc01eee2e3fc1e40fc30a8434e8181f2d8ae049 100644 --- a/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCorey.cpp +++ b/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCorey.cpp @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 02.07.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCorey.h b/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCorey.h index 930998c2250237105410cb3923da726c61ee81b3..529c5b8c832c6d193131756d303ad448f8b190cd 100644 --- a/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCorey.h +++ b/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCorey.h @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCoreyNonwettingPhase.cpp b/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCoreyNonwettingPhase.cpp index 57ec2685ec07e1fce5791e395cc0486caa07e022..fa8fe2d56b48d449cfa11086ccf128f3bc2ba118 100644 --- a/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCoreyNonwettingPhase.cpp +++ b/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCoreyNonwettingPhase.cpp @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 02.07.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCoreyNonwettingPhase.h b/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCoreyNonwettingPhase.h index f138fff8e569fc6a8def8b871938c28d39799d2d..18d6ab9859a01224a28459240bb3ddf2530cafe2 100644 --- a/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCoreyNonwettingPhase.h +++ b/MaterialLib/MPL/Properties/RelativePermeability/RelPermBrooksCoreyNonwettingPhase.h @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/RelativePermeability/RelPermLiakopoulos.cpp b/MaterialLib/MPL/Properties/RelativePermeability/RelPermLiakopoulos.cpp index 9f8549348b8cfaa631e2a700545d9ec6cf4838be..1dee34c3def53fcc2d092c1b6a5fa11b36599f94 100644 --- a/MaterialLib/MPL/Properties/RelativePermeability/RelPermLiakopoulos.cpp +++ b/MaterialLib/MPL/Properties/RelativePermeability/RelPermLiakopoulos.cpp @@ -1,7 +1,6 @@ /** * \file * \author Norbert Grunwald - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/RelativePermeability/RelPermLiakopoulos.h b/MaterialLib/MPL/Properties/RelativePermeability/RelPermLiakopoulos.h index 5f100fa802be87aa18d98a540b847da41151f1b9..a1da12282453843f1c8dcb7ee551b21c81b13c27 100644 --- a/MaterialLib/MPL/Properties/RelativePermeability/RelPermLiakopoulos.h +++ b/MaterialLib/MPL/Properties/RelativePermeability/RelPermLiakopoulos.h @@ -1,7 +1,6 @@ /** * \file * \author Norbert Grunwald - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Properties/SaturationDependentSwelling.h b/MaterialLib/MPL/Properties/SaturationDependentSwelling.h index e372d9f84a9fec628bab3ab4ed6e6547400cf9fa..0e1dc29f12becab3968261cc3427fecb37edaa89 100644 --- a/MaterialLib/MPL/Properties/SaturationDependentSwelling.h +++ b/MaterialLib/MPL/Properties/SaturationDependentSwelling.h @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date 27.06.2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MaterialLib/MPL/Utils/FormKelvinVector.h b/MaterialLib/MPL/Utils/FormKelvinVector.h index a7db805b7fe2fbd4aa3cd542ad93e6458bfb5ee1..6a12b7f79fb1a0c15cdd2f8121015d695454252e 100644 --- a/MaterialLib/MPL/Utils/FormKelvinVector.h +++ b/MaterialLib/MPL/Utils/FormKelvinVector.h @@ -27,9 +27,9 @@ namespace MaterialPropertyLib * three element vector or a 3 x 3 matrix for anisotropic properties, to * get a Kelvin vector for strain or stress. * - * @param values: e.g., Thermal expansivity, which can be scalar number, a three + * \param values: e.g., Thermal expansivity, which can be scalar number, a three * element vector or a 3 x 3 matrix. - * @return Kelvin vector type property. + * \return Kelvin vector type property. */ template <int GlobalDim> MathLib::KelvinVector::KelvinVectorType<GlobalDim> formKelvinVector( diff --git a/MaterialLib/PorousMedium/Permeability/createPermeabilityModel.cpp b/MaterialLib/PorousMedium/Permeability/createPermeabilityModel.cpp index 95bc76637beb2e9836ccc61a609c31d35d5fdabd..3eb5ecf53b69a909f8ee259f82748e6f44597144 100644 --- a/MaterialLib/PorousMedium/Permeability/createPermeabilityModel.cpp +++ b/MaterialLib/PorousMedium/Permeability/createPermeabilityModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 17, 2016, 2:36 PM */ diff --git a/MaterialLib/PorousMedium/Permeability/createPermeabilityModel.h b/MaterialLib/PorousMedium/Permeability/createPermeabilityModel.h index c964ee695038998c377ce686e6340e34e40ef404..f8cfb12c99f6169220aef2ff61d64903f562362e 100644 --- a/MaterialLib/PorousMedium/Permeability/createPermeabilityModel.h +++ b/MaterialLib/PorousMedium/Permeability/createPermeabilityModel.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 17, 2016, 2:36 PM */ @@ -26,10 +26,10 @@ namespace MaterialLib namespace PorousMedium { /** Create a porosity model - * @param config ConfigTree object has a tag of `<permeability>` that + * \param config ConfigTree object has a tag of `<permeability>` that * describes the permeability relationsship and contains the name of the * parameter - * @param parameters a vector containing the available parameters + * \param parameters a vector containing the available parameters */ std::unique_ptr<Permeability> createPermeabilityModel( BaseLib::ConfigTree const& config, diff --git a/MaterialLib/PorousMedium/Porosity/Porosity.h b/MaterialLib/PorousMedium/Porosity/Porosity.h index 07be666a64b3f7589f49564138ebfc51da677e21..d169732ae37ca0b8a8b93eb0a3c6f5b799469fc3 100644 --- a/MaterialLib/PorousMedium/Porosity/Porosity.h +++ b/MaterialLib/PorousMedium/Porosity/Porosity.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 16, 2016, 12:53 PM */ diff --git a/MaterialLib/PorousMedium/Porosity/createPorosityModel.cpp b/MaterialLib/PorousMedium/Porosity/createPorosityModel.cpp index 30f17ff843fdad9b034ac5ba86f085c429555ecb..6eb01934867b442ce187c83f32261eeabf19de4c 100644 --- a/MaterialLib/PorousMedium/Porosity/createPorosityModel.cpp +++ b/MaterialLib/PorousMedium/Porosity/createPorosityModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 16, 2016, 1:16 PM */ diff --git a/MaterialLib/PorousMedium/Porosity/createPorosityModel.h b/MaterialLib/PorousMedium/Porosity/createPorosityModel.h index 76908f193016c7b9bcd1e18b85d8e7eb864ebd61..e178a2e27d69d0b198476b69652c69a22b1fa1a8 100644 --- a/MaterialLib/PorousMedium/Porosity/createPorosityModel.h +++ b/MaterialLib/PorousMedium/Porosity/createPorosityModel.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 16, 2016, 1:16 PM */ diff --git a/MaterialLib/PorousMedium/Storage/ConstantStorage.h b/MaterialLib/PorousMedium/Storage/ConstantStorage.h index 971fd83d081c95a6f3bca0d39123e9831f51b9ec..76bf7e4312aa200df58e792870ccbd686bfb4b43 100644 --- a/MaterialLib/PorousMedium/Storage/ConstantStorage.h +++ b/MaterialLib/PorousMedium/Storage/ConstantStorage.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 16, 2016, 1:03 PM */ diff --git a/MaterialLib/PorousMedium/Storage/Storage.h b/MaterialLib/PorousMedium/Storage/Storage.h index 1831762d75fa511a03d54794424f4cd64ee248fd..bf72408a399e3c101cf0384bfe58c2b0d9cf2b32 100644 --- a/MaterialLib/PorousMedium/Storage/Storage.h +++ b/MaterialLib/PorousMedium/Storage/Storage.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 16, 2016, 12:53 PM */ diff --git a/MaterialLib/PorousMedium/Storage/createStorageModel.cpp b/MaterialLib/PorousMedium/Storage/createStorageModel.cpp index 74664a9560753cd5e973036e5a739e59539f7c8f..c3a5f7d2cea5caeb8b68bc4d85fdd20e1325c77d 100644 --- a/MaterialLib/PorousMedium/Storage/createStorageModel.cpp +++ b/MaterialLib/PorousMedium/Storage/createStorageModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 16, 2016, 1:16 PM */ diff --git a/MaterialLib/PorousMedium/Storage/createStorageModel.h b/MaterialLib/PorousMedium/Storage/createStorageModel.h index d714babffcfb1aa61d7c6a82508c594d58e64a14..3956c76344916b15fcdf76e6bcbb87bf29149adf 100644 --- a/MaterialLib/PorousMedium/Storage/createStorageModel.h +++ b/MaterialLib/PorousMedium/Storage/createStorageModel.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 16, 2016, 1:16 PM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/BrooksCoreyCapillaryPressureSaturation.cpp b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/BrooksCoreyCapillaryPressureSaturation.cpp index e6e930c98309efef5313ac6a413b572e5cc8a0e2..c3a26ebfd466d7b71c27366a86b7cf3ed75c7a40 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/BrooksCoreyCapillaryPressureSaturation.cpp +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/BrooksCoreyCapillaryPressureSaturation.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 1, 2016, 9:45 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/BrooksCoreyCapillaryPressureSaturation.h b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/BrooksCoreyCapillaryPressureSaturation.h index b5e0aef0307949d72a1fdec7b7444e81fb30d3e7..00608bc1587507b0ffd69d76ee9e4537db5543e1 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/BrooksCoreyCapillaryPressureSaturation.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/BrooksCoreyCapillaryPressureSaturation.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 1, 2016, 9:45 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CapillaryPressureSaturation.h b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CapillaryPressureSaturation.h index cfa686334b953eebd3694a415c5dfd932191600a..b45f8390187e252bc07c32b3e8bbcd08161402e6 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CapillaryPressureSaturation.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CapillaryPressureSaturation.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #pragma once diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CapillaryPressureSaturationCurve.h b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CapillaryPressureSaturationCurve.h index d3690b5e65206c55f416a044d0c8bc3b10fefacd..6187d2a7c2beed4cf6c4a6be86a657c308e7e83a 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CapillaryPressureSaturationCurve.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CapillaryPressureSaturationCurve.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 3, 2016, 9:50 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CreateCapillaryPressureModel.cpp b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CreateCapillaryPressureModel.cpp index aff6d719f30c18e93f8711b169d83f7b54f3f9d3..8fd11081a537e6144d506ce79de7b963817a7d4b 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CreateCapillaryPressureModel.cpp +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CreateCapillaryPressureModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 1, 2016, 10:06 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CreateCapillaryPressureModel.h b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CreateCapillaryPressureModel.h index 6b4ed2a28c44443b2dfba444b603b9c31da5e7ff..c888cf4700dc4383ec7c3288a143d9b1ea698d0f 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CreateCapillaryPressureModel.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/CreateCapillaryPressureModel.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 1, 2016, 10:06 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/VanGenuchtenCapillaryPressureSaturation.cpp b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/VanGenuchtenCapillaryPressureSaturation.cpp index 16bee00e91d9c59c066f0c549e3d38b5889d906f..6ca769e12767abef4562012985e7a228190d683d 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/VanGenuchtenCapillaryPressureSaturation.cpp +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/VanGenuchtenCapillaryPressureSaturation.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on October 28, 2016, 6:05 PM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/VanGenuchtenCapillaryPressureSaturation.h b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/VanGenuchtenCapillaryPressureSaturation.h index 75af3f9fa3f748112637cddbd8f0c5f41ca788a5..5012b6d5252cf3ceac8b9aa26966e8724a9cf051 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/VanGenuchtenCapillaryPressureSaturation.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/CapillaryPressure/VanGenuchtenCapillaryPressureSaturation.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on October 28, 2016, 6:05 PM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/CreateRelativePermeabilityModel.cpp b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/CreateRelativePermeabilityModel.cpp index a5d49a577423957115a9611af62e0d049eef558f..98c7712c8db04f1e7b926fae027f916316af5a5c 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/CreateRelativePermeabilityModel.cpp +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/CreateRelativePermeabilityModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 11:43 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/CreateRelativePermeabilityModel.h b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/CreateRelativePermeabilityModel.h index 656ac7c2226e100e6445d955ec92850c7093ff53..31480e97a70233fddd68cf121c2f64f06c8635d0 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/CreateRelativePermeabilityModel.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/CreateRelativePermeabilityModel.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 11:43 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseBrooksCoreyOilGas.cpp b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseBrooksCoreyOilGas.cpp index d4408e88396b2e6c1655f0e50e437a83d1b50c0b..dd147f2359c0b8dafa9f38bceb29893c33c03470 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseBrooksCoreyOilGas.cpp +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseBrooksCoreyOilGas.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 10:47 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseBrooksCoreyOilGas.h b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseBrooksCoreyOilGas.h index f062c098dfcd4dd4f219dd983bb30bf63988e7ce..930df09ae2e745b50f226bae80ee12e6ed983680 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseBrooksCoreyOilGas.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseBrooksCoreyOilGas.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 10:47 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseVanGenuchten.cpp b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseVanGenuchten.cpp index b7bcff298e666b272f919fb7064a4503df34792e..5ad5853a7a3ebd036513535ab9c337bcd5d92dfd 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseVanGenuchten.cpp +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseVanGenuchten.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 11:24 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseVanGenuchten.h b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseVanGenuchten.h index 93afd4442e03c01c9c3208509c218f772c8668a5..05c698f58074105b491756b5fc30861ae1ee9ee6 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseVanGenuchten.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/NonWettingPhaseVanGenuchten.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 11:24 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/RelativePermeability.h b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/RelativePermeability.h index aa2dbcb73c06da9efbf377e027b93688285eac88..a9164677725a72e3f55363388cdd2eb7d5ce94ff 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/RelativePermeability.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/RelativePermeability.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #pragma once diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/RelativePermeabilityCurve.h b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/RelativePermeabilityCurve.h index fe2f92c17e27b62e1c7864d646c37de6b5bad3e9..a77f7339fd73ef73d00e3d0f12cae45b54be28e5 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/RelativePermeabilityCurve.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/RelativePermeabilityCurve.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 1:41 PM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseBrooksCoreyOilGas.cpp b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseBrooksCoreyOilGas.cpp index 100110832ec32aaa6c662656cb5c51ac3cec0a6d..8a2953936ab825b49ed16ba90fbc7fc285adca8b 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseBrooksCoreyOilGas.cpp +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseBrooksCoreyOilGas.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 1, 2016, 3:37 PM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseBrooksCoreyOilGas.h b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseBrooksCoreyOilGas.h index 16bf53e0cd80e4e8bdc17ca7a2a8346bc26cf3e9..cd9d1af3c5520c829c6b9ea6f48c95f8bb9eb7a3 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseBrooksCoreyOilGas.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseBrooksCoreyOilGas.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 1, 2016, 3:37 PM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseVanGenuchten.cpp b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseVanGenuchten.cpp index 5cd08d6d02d5670d57d8d3cd3a0135241e365702..8874f27b0f08a6ca9941677c28e88908e3ca15b0 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseVanGenuchten.cpp +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseVanGenuchten.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 11:24 AM */ diff --git a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseVanGenuchten.h b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseVanGenuchten.h index 3b2970f91457da2b6c0cc242fb1d55265fd2e28f..aeec345c4ef2922b742b9c45f8661de377f99f2f 100644 --- a/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseVanGenuchten.h +++ b/MaterialLib/PorousMedium/UnsaturatedProperty/RelativePermeability/WettingPhaseVanGenuchten.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 11:24 AM */ diff --git a/MaterialLib/SolidModels/CreateConstitutiveRelation.cpp b/MaterialLib/SolidModels/CreateConstitutiveRelation.cpp index a086cc030a89ae5d336e1be2cb36e8a9e6a10a2b..3f3f48121a6fc004fd17db13fb08cf269e98897b 100644 --- a/MaterialLib/SolidModels/CreateConstitutiveRelation.cpp +++ b/MaterialLib/SolidModels/CreateConstitutiveRelation.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 10, 2018, 12:09 PM */ diff --git a/MaterialLib/SolidModels/CreateConstitutiveRelation.h b/MaterialLib/SolidModels/CreateConstitutiveRelation.h index 5b8a7aff46f3e7c292f4313e77ef569686420675..d585dc205a268511c6ead2443113ec74bf7aedaa 100644 --- a/MaterialLib/SolidModels/CreateConstitutiveRelation.h +++ b/MaterialLib/SolidModels/CreateConstitutiveRelation.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 10, 2018, 12:09 PM */ diff --git a/MaterialLib/SolidModels/CreateCreepBGRa.cpp b/MaterialLib/SolidModels/CreateCreepBGRa.cpp index ffab85de7ec9eb414e1bfd70e9d30cd06a971b6c..405e42ee6269f8a9e5ced7006258ff213bea2012 100644 --- a/MaterialLib/SolidModels/CreateCreepBGRa.cpp +++ b/MaterialLib/SolidModels/CreateCreepBGRa.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 11, 2018, 2:26 PM */ diff --git a/MaterialLib/SolidModels/CreateCreepBGRa.h b/MaterialLib/SolidModels/CreateCreepBGRa.h index a9d465c9f63ea7f06e1f1832378519655babd7df..718d6fd87449673fb93e3900e8f90c3025409e31 100644 --- a/MaterialLib/SolidModels/CreateCreepBGRa.h +++ b/MaterialLib/SolidModels/CreateCreepBGRa.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 11, 2018, 2:26 PM */ diff --git a/MaterialLib/SolidModels/CreepBGRa.cpp b/MaterialLib/SolidModels/CreepBGRa.cpp index 061b6db94c68aaa400f214c3fcaa7f22158611ca..692346a69a5aa1be402da6376e00df2ca394982e 100644 --- a/MaterialLib/SolidModels/CreepBGRa.cpp +++ b/MaterialLib/SolidModels/CreepBGRa.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 6, 2018, 9:53 AM */ diff --git a/MaterialLib/SolidModels/CreepBGRa.h b/MaterialLib/SolidModels/CreepBGRa.h index 7b24270d9463278899464b082e436f3ef4a293aa..0a97b8a86e2b1a7ed474a917cff22a706eb29cc6 100644 --- a/MaterialLib/SolidModels/CreepBGRa.h +++ b/MaterialLib/SolidModels/CreepBGRa.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2017, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 6, 2018, 9:53 AM */ diff --git a/MathLib/Curve/CreatePiecewiseLinearCurve.cpp b/MathLib/Curve/CreatePiecewiseLinearCurve.cpp index 44e1e30e883add8804d42872f34501e6d4709af9..1b56d0205e85b958775694305ca534a0e12463bb 100644 --- a/MathLib/Curve/CreatePiecewiseLinearCurve.cpp +++ b/MathLib/Curve/CreatePiecewiseLinearCurve.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 11, 2016, 10:49 AM */ diff --git a/MathLib/Curve/CreatePiecewiseLinearCurve.h b/MathLib/Curve/CreatePiecewiseLinearCurve.h index 625952e1a9d81e226d79af3b4a5fe1225e518ae7..f2f59230df5ec0bf73b39e901e33827193253836 100644 --- a/MathLib/Curve/CreatePiecewiseLinearCurve.h +++ b/MathLib/Curve/CreatePiecewiseLinearCurve.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 11, 2016, 10:49 AM */ diff --git a/MathLib/Curve/PiecewiseLinearMonotonicCurve.cpp b/MathLib/Curve/PiecewiseLinearMonotonicCurve.cpp index b20775d14837b93ae7df67ec5c2c8e5c4193f98c..dcf361d91f1da2156d8e070abdc21d6d0ebfe187 100644 --- a/MathLib/Curve/PiecewiseLinearMonotonicCurve.cpp +++ b/MathLib/Curve/PiecewiseLinearMonotonicCurve.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 11, 2016, 10:49 AM */ diff --git a/MathLib/Curve/PiecewiseLinearMonotonicCurve.h b/MathLib/Curve/PiecewiseLinearMonotonicCurve.h index 2f60df767ecfa01581c7f34d755bef69b3abe7ba..cabfd47ca3044f6868b6dcafcd8604fcafdd4f02 100644 --- a/MathLib/Curve/PiecewiseLinearMonotonicCurve.h +++ b/MathLib/Curve/PiecewiseLinearMonotonicCurve.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 11, 2016, 10:49 AM */ diff --git a/MathLib/GeometricBasics.h b/MathLib/GeometricBasics.h index 8ab15c4cd6e159221ddc52406a5a3107dc1e1ed7..634b5c1a3d0ef5899b1437bebdc812418fcce571 100644 --- a/MathLib/GeometricBasics.h +++ b/MathLib/GeometricBasics.h @@ -25,11 +25,11 @@ enum TriangleTest /** * Checks if a point p is on the left or right side of a plane spanned by three * points a, b, c. - * @param p point to test - * @param a first point on plane - * @param b second point on plane - * @param c third point on plane - * @return If the triangle abc is ordered counterclockwise when viewed from p, + * \param p point to test + * \param a first point on plane + * \param b second point on plane + * \param c third point on plane + * \return If the triangle abc is ordered counterclockwise when viewed from p, * the method will return a negative value, * otherwise it will return a positive value. If p is coplanar with abc, the * function will return 0. @@ -63,14 +63,14 @@ double calcTriangleArea(MathLib::Point3d const& a, MathLib::Point3d const& b, * coplanar) the function * will return false because there is no meaningful concept of "inside" for such * elements. - * @param p test point - * @param a edge node of tetrahedron - * @param b edge node of tetrahedron - * @param c edge node of tetrahedron - * @param d edge node of tetrahedron - * @param eps Accounts for numerical inaccuracies by allowing a point to be + * \param p test point + * \param a edge node of tetrahedron + * \param b edge node of tetrahedron + * \param c edge node of tetrahedron + * \param d edge node of tetrahedron + * \param eps Accounts for numerical inaccuracies by allowing a point to be * slightly outside of the element and still be regarded as inside. - * @return true if the test point p is not located outside of abcd (i.e. inside + * \return true if the test point p is not located outside of abcd (i.e. inside * or on a plane/edge). */ bool isPointInTetrahedron(MathLib::Point3d const& p, MathLib::Point3d const& a, @@ -83,16 +83,16 @@ bool isPointInTetrahedron(MathLib::Point3d const& p, MathLib::Point3d const& a, * a, b and c.Using two eps-values it is possible to test an 'epsilon' * neighbourhood around the triangle as well as an 'epsilon' outside the * triangles plane. - * @param p test point - * @param a edge node of triangle - * @param b edge node of triangle - * @param c edge node of triangle - * @param eps_pnt_out_of_plane eps allowing for p to be slightly off the plane + * \param p test point + * \param a edge node of triangle + * \param b edge node of triangle + * \param c edge node of triangle + * \param eps_pnt_out_of_plane eps allowing for p to be slightly off the plane * spanned by abc - * @param eps_pnt_out_of_tri eps allowing for p to be slightly off outside of + * \param eps_pnt_out_of_tri eps allowing for p to be slightly off outside of * abc - * @param algorithm defines the method to use - * @return true if the test point p is within the 'epsilon'-neighbourhood of the + * \param algorithm defines the method to use + * \return true if the test point p is within the 'epsilon'-neighbourhood of the * triangle */ bool isPointInTriangle( @@ -110,15 +110,15 @@ bool isPointInTriangle( * Using two eps-values it is possible to test an 'epsilon' neighbourhood around * the triangle * as well as an 'epsilon' outside the triangles plane. - * @param q test point - * @param a edge node of triangle - * @param b edge node of triangle - * @param c edge node of triangle - * @param eps_pnt_out_of_plane eps allowing for p to be slightly off the plane + * \param q test point + * \param a edge node of triangle + * \param b edge node of triangle + * \param c edge node of triangle + * \param eps_pnt_out_of_plane eps allowing for p to be slightly off the plane * spanned by abc ((orthogonal distance to the plane spaned by triangle) - * @param eps_pnt_out_of_tri eps allowing for p to be slightly off outside of + * \param eps_pnt_out_of_tri eps allowing for p to be slightly off outside of * abc - * @return true if the test point p is within the 'epsilon'-neighbourhood of the + * \return true if the test point p is within the 'epsilon'-neighbourhood of the * triangle */ bool gaussPointInTriangle( @@ -134,15 +134,15 @@ bool gaussPointInTriangle( * the triangle * as well as an 'epsilon' outside the triangles plane. * Algorithm based on "Fundamentals of Computer Graphics" by Peter Shirley. - * @param p test point - * @param a edge node of triangle - * @param b edge node of triangle - * @param c edge node of triangle - * @param eps_pnt_out_of_plane eps allowing for p to be slightly off the plane + * \param p test point + * \param a edge node of triangle + * \param b edge node of triangle + * \param c edge node of triangle + * \param eps_pnt_out_of_plane eps allowing for p to be slightly off the plane * spanned by abc - * @param eps_pnt_out_of_tri eps allowing for p to be slightly off outside of + * \param eps_pnt_out_of_tri eps allowing for p to be slightly off outside of * abc - * @return true if the test point p is within the 'epsilon'-neighbourhood of the + * \return true if the test point p is within the 'epsilon'-neighbourhood of the * triangle */ bool barycentricPointInTriangle( @@ -162,11 +162,11 @@ MathLib::Point3d const& b, MathLib::Point3d const& c); * Checks if a and b can be placed on a plane such that c and d lie on different * sides of said plane. (In 2D space this checks if c and d are on different * sides of a line through a and b.) - * @param a first point on plane - * @param b second point on plane - * @param c first point to test - * @param d second point to test - * @return true, if such a plane can be found, false otherwise + * \param a first point on plane + * \param b second point on plane + * \param c first point to test + * \param d second point to test + * \return true, if such a plane can be found, false otherwise */ bool dividedByPlane(const MathLib::Point3d& a, const MathLib::Point3d& b, const MathLib::Point3d& c, const MathLib::Point3d& d); diff --git a/MathLib/Integration/GaussLegendre.cpp b/MathLib/Integration/GaussLegendre.cpp index cf7ddc7f8ec059ee594b39063768a04935bd1269..a914f8688092d50ac137c82e251fbb7d422c4c03 100644 --- a/MathLib/Integration/GaussLegendre.cpp +++ b/MathLib/Integration/GaussLegendre.cpp @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MathLib/Integration/GaussLegendre.h b/MathLib/Integration/GaussLegendre.h index 767d0aa0cae553d8853e3ca4f70a8b372b2b68c7..f50a65801d431ab17f952ffb260b4f0240a46679 100644 --- a/MathLib/Integration/GaussLegendre.h +++ b/MathLib/Integration/GaussLegendre.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MathLib/Integration/GaussLegendreTri.cpp b/MathLib/Integration/GaussLegendreTri.cpp index b4d170b1fb607739a63421d8f9cfcd3d7e3798d9..f983089bd1938c665faeb9587c56b7e4633632cd 100644 --- a/MathLib/Integration/GaussLegendreTri.cpp +++ b/MathLib/Integration/GaussLegendreTri.cpp @@ -2,7 +2,6 @@ * \file * \author Norihiro Watanabe * \date 2013-08-13 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MathLib/Integration/GaussLegendreTri.h b/MathLib/Integration/GaussLegendreTri.h index 5bc4ca837f21023798c379ad3f06f702ada3d4c3..719134940b3fb71d0872c5fdb7251b0a151d2c7d 100644 --- a/MathLib/Integration/GaussLegendreTri.h +++ b/MathLib/Integration/GaussLegendreTri.h @@ -2,7 +2,6 @@ * \file * \author Norihiro Watanabe * \date 2013-08-13 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/MathLib/InterpolationAlgorithms/LinearIntervalInterpolation.h b/MathLib/InterpolationAlgorithms/LinearIntervalInterpolation.h index e678337195dca73d40b515726b7d18ad8110f05a..0e0351d4111a81b4c142b9ff8a9f856cc65f1e90 100644 --- a/MathLib/InterpolationAlgorithms/LinearIntervalInterpolation.h +++ b/MathLib/InterpolationAlgorithms/LinearIntervalInterpolation.h @@ -19,12 +19,12 @@ namespace MathLib { /** - * @brief Class (template) LinearIntervalInterpolation is a functional object performing - * an interval mapping \f$f: [a,b] \to [c,d]\f$. + * \brief Class (template) LinearIntervalInterpolation is a functional object + * performing an interval mapping \f$f: [a,b] \to [c,d]\f$. * - * Input numeric type has to be a floating point type and must behave well under the - * operations addition, subtraction, multiplication and division. Let \f$a, b, c, d\f$ - * objects supporting the mentioned operations. Under the condition + * Input numeric type has to be a floating point type and must behave well under + * the operations addition, subtraction, multiplication and division. Let \f$a, + * b, c, d\f$ objects supporting the mentioned operations. Under the condition * \f$a \neq b\f$ an instance of the class computes a value within the interval * \f$[c, d]\f$, i.e., \f$f: [a,b] \to [c,d]\f$. */ @@ -35,16 +35,17 @@ public: * Constructor of class template for a linear map \f$y = m \cdot x + n\f$. * Under the prerequisite \f$a \neq b\f$ it initializes the coefficients * \f$m\f$ and \f$n\f$ in a correct way. - * @param a first endpoint of the first interval - * @param b second endpoint of the first interval - * @param c first endpoint of the second interval - * @param d second endpoint of the second interval + * \param a first endpoint of the first interval + * \param b second endpoint of the first interval + * \param c first endpoint of the second interval + * \param d second endpoint of the second interval */ LinearIntervalInterpolation(NUMERIC_TYPE a, NUMERIC_TYPE b, NUMERIC_TYPE c, NUMERIC_TYPE d); /** - * Method computes the value at point \f$x\f$ obtained by linear interpolation. - * @param x the point the interpolation value is searched for - * @return the interpolation value at point \f$x\f$ + * Method computes the value at point \f$x\f$ obtained by linear + * interpolation. + * \param x the point the interpolation value is searched for + * \return the interpolation value at point \f$x\f$ */ inline NUMERIC_TYPE operator() (NUMERIC_TYPE x) const; diff --git a/MathLib/LinAlg/Eigen/EigenTools.h b/MathLib/LinAlg/Eigen/EigenTools.h index 917d4c63e2b75f10d0d381a105dc9c7322d9eb20..552add71ca238eb43a63dd01f489ead7face9bae 100644 --- a/MathLib/LinAlg/Eigen/EigenTools.h +++ b/MathLib/LinAlg/Eigen/EigenTools.h @@ -22,10 +22,10 @@ class EigenVector; /** * apply known solutions to a system of linear equations * - * @param A Coefficient matrix - * @param b RHS vector - * @param vec_knownX_id a vector of known solution entry IDs - * @param vec_knownX_x a vector of known solutions + * \param A Coefficient matrix + * \param b RHS vector + * \param vec_knownX_id a vector of known solution entry IDs + * \param vec_knownX_x a vector of known solutions */ void applyKnownSolution( EigenMatrix& A, EigenVector& b, EigenVector& /*x*/, diff --git a/MathLib/LinAlg/LinAlgEnums.cpp b/MathLib/LinAlg/LinAlgEnums.cpp index cb398b94f588998b2ca4cf3444c0fd4698469fb2..4e03ac1cbe4fd894824254a553b5b2448af211f1 100644 --- a/MathLib/LinAlg/LinAlgEnums.cpp +++ b/MathLib/LinAlg/LinAlgEnums.cpp @@ -1,7 +1,7 @@ /** + * \file * \author Wenqing Wang * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MathLib/LinAlg/LinAlgEnums.h b/MathLib/LinAlg/LinAlgEnums.h index 32f7efddf7d3e619ea8e97e9299705ba4b6d8205..a0a24a17bf8338aacf9490c4d22d53dcec78dafc 100644 --- a/MathLib/LinAlg/LinAlgEnums.h +++ b/MathLib/LinAlg/LinAlgEnums.h @@ -1,7 +1,7 @@ /** + * \file * \author Wenqing Wang * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MathLib/LinAlg/LinearSolverOptions.cpp b/MathLib/LinAlg/LinearSolverOptions.cpp index 3d1f4f830aacfd933af07a5648ea8fc66b5e661b..9763eda9eb215e03720c6bbde42b37efc4589edf 100644 --- a/MathLib/LinAlg/LinearSolverOptions.cpp +++ b/MathLib/LinAlg/LinearSolverOptions.cpp @@ -1,3 +1,12 @@ +/** + * \file + * \copyright + * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) + * Distributed under a Modified BSD License. + * See accompanying file LICENSE.txt or + * http://www.opengeosys.org/project/license + */ + #include "LinearSolverOptions.h" #include <set> diff --git a/MathLib/LinAlg/Lis/LisCheck.h b/MathLib/LinAlg/Lis/LisCheck.h index 595ea52b5314197808968f616d0c7d85843ed101..530fc0e6852bb90161d2261efb6dc385cf87ff35 100644 --- a/MathLib/LinAlg/Lis/LisCheck.h +++ b/MathLib/LinAlg/Lis/LisCheck.h @@ -2,7 +2,6 @@ * \file * \author Norihiro Watanabe * \date 2013-04-16 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) @@ -26,8 +25,8 @@ namespace MathLib /** * check Lis error codes * - * @param err Lis error code - * @return success or not + * \param err Lis error code + * \return success or not */ inline bool checkLisError(int err) { diff --git a/MathLib/MathTools.h b/MathLib/MathTools.h index 2906713cc724b71288953ee0042e1c90e13b4d26..0dfafc86da3e5b1fc5231b5994f9c8a3be24981f 100644 --- a/MathLib/MathTools.h +++ b/MathLib/MathTools.h @@ -37,10 +37,10 @@ double calcProjPntToLineAndDists(MathLib::Point3d const& pp, /** * Let \f$p_0, p_1, p_2 \in R^3\f$. The function getAngle * computes the angle between the edges \f$(p_0,p_1)\f$ and \f$(p_1,p_2)\f$ - * @param p0 start point of edge 0 - * @param p1 end point of edge 0 and start point of edge 1 - * @param p2 end point of edge 1 - * @return the angle between the edges + * \param p0 start point of edge 0 + * \param p1 end point of edge 0 and start point of edge 1 + * \param p2 end point of edge 1 + * \return the angle between the edges */ double getAngle(Point3d const& p0, Point3d const& p1, Point3d const& p2); } // namespace MathLib diff --git a/MathLib/Point3d.h b/MathLib/Point3d.h index ebb16bf37fd6fa590c1f1f061c42f2e0df9e94e0..a3ac832c38d58bb86d15947589e7ba19a2bb6b45 100644 --- a/MathLib/Point3d.h +++ b/MathLib/Point3d.h @@ -31,7 +31,7 @@ public: /** constructor - constructs a Point3d object * - * @param x std::array containing the coordinates of the point + * \param x std::array containing the coordinates of the point */ explicit Point3d(std::array<double, 3> x); @@ -80,11 +80,11 @@ inline bool operator<(Point3d const& a, Point3d const& b) /** * Lexicographic comparison of points taking an epsilon into account. * - * @param a first input point. - * @param b second input point. - * @param eps tolerance used in comparison of coordinates. + * \param a first input point. + * \param b second input point. + * \param eps tolerance used in comparison of coordinates. * - * @return true, if a is smaller then or equal to b according to the following + * \return true, if a is smaller then or equal to b according to the following * test \f$ |a_i - b_i| > \epsilon \cdot \min (|a_i|, |b_i|) \f$ \b and * \f$ |a_i - b_i| > \epsilon \f$ for all coordinates \f$ 0 \le i < 3 \f$. */ @@ -101,9 +101,9 @@ inline std::ostream& operator<<(std::ostream& os, const Point3d& p) extern MATHLIB_EXPORT const Point3d ORIGIN; /** * rotation of points - * @param mat a rotation matrix - * @param p a point to be transformed - * @return a rotated point + * \param mat a rotation matrix + * \param p a point to be transformed + * \return a rotated point */ MathLib::Point3d operator*(Eigen::Matrix3d const& mat, MathLib::Point3d const& p); diff --git a/MeshGeoToolsLib/AppendLinesAlongPolyline.h b/MeshGeoToolsLib/AppendLinesAlongPolyline.h index 3c1c1c693ee721b057dbea31a927217455508a01..2616689519f09880e33f54816c70f3f8210f74a4 100644 --- a/MeshGeoToolsLib/AppendLinesAlongPolyline.h +++ b/MeshGeoToolsLib/AppendLinesAlongPolyline.h @@ -29,15 +29,16 @@ namespace MeshGeoToolsLib /** * Add line elements to a copy of a given mesh * - * The function creates line elements from nodes located along user-provided polylines. - * New elements will have a distinct material ID for each polyline. + * The function creates line elements from nodes located along user-provided + * polylines. New elements will have a distinct material ID for each polyline. * * \remark The function allows creation of duplicated line elements. * \remark Line elements may not be placed along edges of existing elements. * - * @param mesh original mesh - * @param ply_vec polyline vector whose nodes are used to create line elements - * @return a new mesh which is copied from a given mesh and additionally includes line elements + * \param mesh original mesh + * \param ply_vec polyline vector whose nodes are used to create line elements + * \return a new mesh which is copied from a given mesh and additionally + * includes line elements */ std::unique_ptr<MeshLib::Mesh> appendLinesAlongPolylines( const MeshLib::Mesh& mesh, const GeoLib::PolylineVec& ply_vec); diff --git a/MeshGeoToolsLib/MeshNodesAlongSurface.cpp b/MeshGeoToolsLib/MeshNodesAlongSurface.cpp index 970fbcccf07c7381b008c0d7826017f39348131e..d9a2223845d2e2726077bbffc4253e07191a8246 100644 --- a/MeshGeoToolsLib/MeshNodesAlongSurface.cpp +++ b/MeshGeoToolsLib/MeshNodesAlongSurface.cpp @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2014-03-14 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MeshGeoToolsLib/MeshNodesAlongSurface.h b/MeshGeoToolsLib/MeshNodesAlongSurface.h index 22fe69c981937f5806672375d316309e86a4aa62..1edd01bafdebcc5c9b1f40aa174e8e5391f95fe5 100644 --- a/MeshGeoToolsLib/MeshNodesAlongSurface.h +++ b/MeshGeoToolsLib/MeshNodesAlongSurface.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2014-03-14 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MeshLib/Elements/Element.h b/MeshLib/Elements/Element.h index 7d05ee95fabd28a75121e51b4cff4a1e93b682ea..cf651bba3738bc4c8ea78ea80254b976a3913a41 100644 --- a/MeshLib/Elements/Element.h +++ b/MeshLib/Elements/Element.h @@ -49,19 +49,19 @@ public: /** * Get node with local index where the local index should be at most the * number of nodes of the element. - * @param idx local index of node, at most the number of nodes of the + * \param idx local index of node, at most the number of nodes of the * element that you can obtain with Element::getNumberOfBaseNodes() - * @return a pointer to the appropriate (and constant, i.e. not + * \return a pointer to the appropriate (and constant, i.e. not * modifiable by the user) instance of class Node or a nullptr - * @sa getNodeIndex() + * \sa getNodeIndex() */ virtual const Node* getNode(unsigned idx) const = 0; virtual Node* getNode(unsigned idx) = 0; /** * (Re)Sets the node of the element. - * @param idx the index of the pointer to a node within the element - * @param node a pointer to a node + * \param idx the index of the pointer to a node within the element + * \param node a pointer to a node */ virtual void setNode(unsigned idx, Node* node) = 0; @@ -119,7 +119,7 @@ public: /** * Get the type of the element in context of the finite element method. - * @return a value of the enum FEMElemType::type + * \return a value of the enum FEMElemType::type */ virtual CellType getCellType() const = 0; @@ -132,10 +132,10 @@ public: /** * Checks if a point is inside the element. - * @param pnt a 3D MathLib::Point3d object - * @param eps tolerance for numerical algorithm used or computing the + * \param pnt a 3D MathLib::Point3d object + * \param eps tolerance for numerical algorithm used or computing the * property - * @return true if the point is not outside the element, false otherwise + * \return true if the point is not outside the element, false otherwise */ virtual bool isPntInElement( MathLib::Point3d const& pnt, @@ -153,7 +153,7 @@ public: * Method clone is a pure virtual method in the abstract base class Element. * It has to be implemented in the derived classes (for instance in class * Hex). - * @return an exact copy of the object + * \return an exact copy of the object */ virtual Element* clone() const = 0; @@ -237,13 +237,13 @@ unsigned getNodeIDinElement(Element const& element, const Node* node); /** * Get the global node index of the node with the local index idx within the * element. The index should be at most the number of nodes of the element. - * @param element The element object that will be searched for the index. - * @param idx Local index of Node, at most the number of nodes of the + * \param element The element object that will be searched for the index. + * \param idx Local index of Node, at most the number of nodes of the * element that you can obtain with Element::getNumberOfBaseNodes(). - * @return the global index if idx < Element::getNumberOfBaseNodes. Otherwise in + * \return the global index if idx < Element::getNumberOfBaseNodes. Otherwise in * debug mode the value std::numeric_limits<unsigned>::max(). In release mode * the behaviour is undefined. - * @sa Element::getNode() + * \sa Element::getNode() */ std::size_t getNodeIndex(Element const& element, unsigned idx); diff --git a/MeshLib/Elements/HexRule20.h b/MeshLib/Elements/HexRule20.h index 7b4a6cbd91eec14156090496d22a3a2eada52352..19bb18bacb9a68a9950825d30a2a88f3e3d21362 100644 --- a/MeshLib/Elements/HexRule20.h +++ b/MeshLib/Elements/HexRule20.h @@ -20,7 +20,7 @@ namespace MeshLib /** * A 20-nodes Hexahedron Element. - * @code + * \code * * Hex: * 14 @@ -41,7 +41,7 @@ namespace MeshLib * 0-----------1 * 8 * - * @endcode + * \endcode */ class HexRule20 : public HexRule8 { diff --git a/MeshLib/Elements/HexRule8.h b/MeshLib/Elements/HexRule8.h index 2192763903ba1a0282da66ab512e3a2de69cf7e0..d1501fbfb493bf721591370fe0f4d1f579f783c7 100644 --- a/MeshLib/Elements/HexRule8.h +++ b/MeshLib/Elements/HexRule8.h @@ -20,7 +20,7 @@ namespace MeshLib /** * A 8-nodes Hexahedron Element. - * @code + * \code * * Hex: * 6 @@ -41,7 +41,7 @@ namespace MeshLib * 0-----------1 * 0 * - * @endcode + * \endcode */ class HexRule8 : public CellRule { @@ -81,7 +81,7 @@ public: /** * \copydoc MeshLib::Element::isPntInElement() - * @param nodes the nodes of the element. + * \param nodes the nodes of the element. */ static bool isPntInElement(Node const* const* nodes, MathLib::Point3d const& pnt, double eps); diff --git a/MeshLib/Elements/LineRule2.h b/MeshLib/Elements/LineRule2.h index bc57d0ac186af68b85fe2bbb4a56285a1e8e20d0..538eb078eeff6daa6afc285b1d1eb810cd4ddbc3 100644 --- a/MeshLib/Elements/LineRule2.h +++ b/MeshLib/Elements/LineRule2.h @@ -20,9 +20,9 @@ namespace MeshLib /** * A 1d Edge or Line Element. - * @code + * \code * 0--------1 - * @endcode + * \endcode */ class LineRule2 : public EdgeRule { @@ -50,7 +50,7 @@ public: /** * \copydoc MeshLib::Element::isPntInElement() - * @param nodes the nodes of the element. + * \param nodes the nodes of the element. */ static bool isPntInElement(Node const* const* nodes, MathLib::Point3d const& pnt, double eps); diff --git a/MeshLib/Elements/LineRule3.h b/MeshLib/Elements/LineRule3.h index bde5a38125e1ed824ad2ae66e56fd73528d196c7..6b4d2259141a68ce563b4b0af0f61e3e0aff2a64 100644 --- a/MeshLib/Elements/LineRule3.h +++ b/MeshLib/Elements/LineRule3.h @@ -18,9 +18,9 @@ namespace MeshLib /** * A 1d Edge or Line element with 3 nodes. - * @code + * \code * 0----2----1 - * @endcode + * \endcode */ class LineRule3 : public LineRule2 { diff --git a/MeshLib/Elements/PrismRule15.h b/MeshLib/Elements/PrismRule15.h index 4a9d744456da1dc7e5a86fb82be6cb71bafb336f..a6ae0de9307d10cdfe1ec6af4facd351cc36646f 100644 --- a/MeshLib/Elements/PrismRule15.h +++ b/MeshLib/Elements/PrismRule15.h @@ -19,9 +19,10 @@ namespace MeshLib { /** - * This class represents a 3d prism element with 15 nodes. The following sketch shows the node and edge numbering. - * @anchor PrismNodeAndEdgeNumbering - * @code + * This class represents a 3d prism element with 15 nodes. The following sketch + * shows the node and edge numbering. + * \anchor PrismNodeAndEdgeNumbering + * \code * 5 * / \ * / : \ @@ -39,7 +40,7 @@ namespace MeshLib * 0-----------1 * 6 * - * @endcode + * \endcode */ class PrismRule15 : public PrismRule6 { diff --git a/MeshLib/Elements/PrismRule6.h b/MeshLib/Elements/PrismRule6.h index 0a23f592df6e5d1a1e59b0419e53ba08f35b1c4a..42190daed1c46756ed6c25747060cd102ab87f48 100644 --- a/MeshLib/Elements/PrismRule6.h +++ b/MeshLib/Elements/PrismRule6.h @@ -19,9 +19,10 @@ namespace MeshLib { /** - * This class represents a 3d prism element. The following sketch shows the node and edge numbering. - * @anchor Prism6NodeAndEdgeNumbering - * @code + * This class represents a 3d prism element. The following sketch shows the node + * and edge numbering. + * \anchor Prism6NodeAndEdgeNumbering + * \code * 5 * / \ * / : \ @@ -39,7 +40,7 @@ namespace MeshLib * 0-----------1 * 0 * - * @endcode + * \endcode */ class PrismRule6 : public CellRule { @@ -82,7 +83,7 @@ public: /** * \copydoc MeshLib::Element::isPntInElement() - * @param nodes the nodes of the element. + * \param nodes the nodes of the element. */ static bool isPntInElement(Node const* const* nodes, MathLib::Point3d const& pnt, double eps); diff --git a/MeshLib/Elements/PyramidRule13.h b/MeshLib/Elements/PyramidRule13.h index b80ad85b19f26aa4e57f4dbe1986bbfb77ea99d7..67fa809c2bdbdacdc91896bb47e8cb8d2fbf77eb 100644 --- a/MeshLib/Elements/PyramidRule13.h +++ b/MeshLib/Elements/PyramidRule13.h @@ -20,8 +20,8 @@ namespace MeshLib /** * This class represents a 3d pyramid element. The following sketch shows the node numbering. - * @anchor Pyramid13NodeNumbering - * @code + * \anchor Pyramid13NodeNumbering + * \code * * 4 * //|\ @@ -37,7 +37,7 @@ namespace MeshLib * ./ |/ * 0------------1 * 5 - * @endcode + * \endcode */ class PyramidRule13 : public PyramidRule5 diff --git a/MeshLib/Elements/PyramidRule5.h b/MeshLib/Elements/PyramidRule5.h index 336444ae26bdba41952613a5a3fb381ea3b04152..d3d9720595b2c72ebe26e080e24fd0d3451a4aa8 100644 --- a/MeshLib/Elements/PyramidRule5.h +++ b/MeshLib/Elements/PyramidRule5.h @@ -19,9 +19,10 @@ namespace MeshLib { /** - * This class represents a 3d pyramid element. The following sketch shows the node and edge numbering. - * @anchor Pyramid5NodeAndEdgeNumbering - * @code + * This class represents a 3d pyramid element. The following sketch shows the + node and edge numbering. + * \anchor Pyramid5NodeAndEdgeNumbering + * \code * * 4 * //|\ @@ -37,7 +38,7 @@ namespace MeshLib * ./ |/ * 0------------1 * 0 - * @endcode + * \endcode */ class PyramidRule5 : public CellRule @@ -81,7 +82,7 @@ public: /** * \copydoc MeshLib::Element::isPntInElement() - * @param nodes the nodes of the element. + * \param nodes the nodes of the element. */ static bool isPntInElement(Node const* const* nodes, MathLib::Point3d const& pnt, double eps); diff --git a/MeshLib/Elements/QuadRule4.h b/MeshLib/Elements/QuadRule4.h index 3b10b75ba51aa9755da2f0e2c37c368dd2870455..3616c9b09924f24243f367fafbf633bac90ff258 100644 --- a/MeshLib/Elements/QuadRule4.h +++ b/MeshLib/Elements/QuadRule4.h @@ -20,9 +20,10 @@ namespace MeshLib { /** - * This class represents a 2d quadrilateral element. The following sketch shows the node and edge numbering. - * @anchor QuadNodeAndEdgeNumbering - * @code + * This class represents a 2d quadrilateral element. The following sketch shows + * the node and edge numbering. + * \anchor QuadNodeAndEdgeNumbering + * \code * 2 * 3-----------2 * | | @@ -32,7 +33,7 @@ namespace MeshLib * | | * 0-----------1 * 0 - * @endcode + * \endcode */ class QuadRule4 : public FaceRule { @@ -63,7 +64,7 @@ public: /** * \copydoc MeshLib::Element::isPntInElement() - * @param nodes the nodes of the element. + * \param nodes the nodes of the element. */ static bool isPntInElement(Node const* const* nodes, MathLib::Point3d const& pnt, double eps); diff --git a/MeshLib/Elements/QuadRule8.h b/MeshLib/Elements/QuadRule8.h index b4b141b84e66cb2668ebd9bebfcb7a71b1107fc6..f25c10834300e6ca75bc36ec8b415a97d5694de2 100644 --- a/MeshLib/Elements/QuadRule8.h +++ b/MeshLib/Elements/QuadRule8.h @@ -20,8 +20,8 @@ namespace MeshLib /** * This class represents a 2d quadrilateral element with 8 nodes. * The following sketch shows the node and edge numbering. - * @anchor Quad8NodeAndEdgeNumbering - * @code + * \anchor Quad8NodeAndEdgeNumbering + * \code * 2 * 3-----6-----2 * | | @@ -31,7 +31,7 @@ namespace MeshLib * | | * 0-----4-----1 * 0 - * @endcode + * \endcode */ class QuadRule8 : public QuadRule4 { diff --git a/MeshLib/Elements/QuadRule9.h b/MeshLib/Elements/QuadRule9.h index bfefe156d52646d78a8069b4876525d18e50e2b5..81fb6e94c41e2f4a3ef7a645331d989a9d87aa9f 100644 --- a/MeshLib/Elements/QuadRule9.h +++ b/MeshLib/Elements/QuadRule9.h @@ -19,8 +19,8 @@ namespace MeshLib /** * This class represents a 2d quadrilateral element with 9 nodes. * The following sketch shows the node and edge numbering. - * @anchor Quad9NodeAndEdgeNumbering - * @code + * \anchor Quad9NodeAndEdgeNumbering + * \code * 2 * 3-----6-----2 * | | @@ -30,7 +30,7 @@ namespace MeshLib * | | * 0-----4-----1 * 0 - * @endcode + * \endcode */ class QuadRule9 : public QuadRule8 { diff --git a/MeshLib/Elements/TetRule10.h b/MeshLib/Elements/TetRule10.h index 6cbb41c5a7b8f03c2800d381e0202446b5648526..3b7a31adbfd93efa690242b6627e376d256bb97f 100644 --- a/MeshLib/Elements/TetRule10.h +++ b/MeshLib/Elements/TetRule10.h @@ -19,9 +19,10 @@ namespace MeshLib { /** - * This class represents a 3d tetrahedron element with 10 nodes. The following sketch shows the node and edge numbering. - * @anchor TetrahedronNodeAndEdgeNumbering - * @code + * This class represents a 3d tetrahedron element with 10 nodes. The following + * sketch shows the node and edge numbering. + * \anchor TetrahedronNodeAndEdgeNumbering + * \code * 3 * /|\ * / | \ @@ -36,7 +37,7 @@ namespace MeshLib * \|/ * 1 * - * @endcode + * \endcode */ class TetRule10 : public TetRule4 { diff --git a/MeshLib/Elements/TetRule4.h b/MeshLib/Elements/TetRule4.h index 02d3203012c2270d6b5e1a064116d90a1beaf241..b5fbd63b3c08f52987b2845c5ddfc8290eff06e9 100644 --- a/MeshLib/Elements/TetRule4.h +++ b/MeshLib/Elements/TetRule4.h @@ -19,9 +19,10 @@ namespace MeshLib { /** - * This class represents a 3d tetrahedron element. The following sketch shows the node and edge numbering. - * @anchor Tetrahedron4NodeAndEdgeNumbering - * @code + * This class represents a 3d tetrahedron element. The following sketch shows + * the node and edge numbering. + * \anchor Tetrahedron4NodeAndEdgeNumbering + * \code * 3 * /|\ * / | \ @@ -36,7 +37,7 @@ namespace MeshLib * \|/ * 1 * - * @endcode + * \endcode */ class TetRule4 : public CellRule { @@ -76,7 +77,7 @@ public: /** * \copydoc MeshLib::Element::isPntInElement() - * @param nodes the nodes of the element. + * \param nodes the nodes of the element. */ static bool isPntInElement(Node const* const* nodes, MathLib::Point3d const& pnt, double eps); diff --git a/MeshLib/Elements/TriRule3.h b/MeshLib/Elements/TriRule3.h index 0119b73a276ff0f7bfcb3f398d4206c38e4f015d..60f8c565b18f30dad2344bfecd044e9d7920c0d6 100644 --- a/MeshLib/Elements/TriRule3.h +++ b/MeshLib/Elements/TriRule3.h @@ -19,9 +19,10 @@ namespace MeshLib { /** - * This class represents a 2d triangle element. The following sketch shows the node and edge numbering. - * @anchor TriNodeAndEdgeNumbering - * @code + * This class represents a 2d triangle element. The following sketch shows the + * node and edge numbering. + * \anchor TriNodeAndEdgeNumbering + * \code * * 2 * o @@ -33,7 +34,7 @@ namespace MeshLib * 0-----------1 * 0 * - * @endcode + * \endcode */ class TriRule3 : public FaceRule { @@ -64,7 +65,7 @@ public: /** * \copydoc MeshLib::Element::isPntInElement() - * @param nodes the nodes of the element. + * \param nodes the nodes of the element. */ static bool isPntInElement(Node const* const* nodes, MathLib::Point3d const& pnt, double eps); diff --git a/MeshLib/Elements/TriRule6.h b/MeshLib/Elements/TriRule6.h index 8ca4361246d0725199e6cec8ad76acf3de0025f9..77981eee75386802978837d84f193f81f4e471a8 100644 --- a/MeshLib/Elements/TriRule6.h +++ b/MeshLib/Elements/TriRule6.h @@ -21,8 +21,8 @@ namespace MeshLib * This class represents a 2d triangle element with 6 nodes. * * The following sketch shows the node and edge numbering. - * @anchor Tri6NodeAndEdgeNumbering - * @code + * \anchor Tri6NodeAndEdgeNumbering + * \code * * 2 * o @@ -34,7 +34,7 @@ namespace MeshLib * 0-----------1 * 3 * - * @endcode + * \endcode */ class TriRule6 : public TriRule3 { diff --git a/MeshLib/IO/Legacy/MeshIO.cpp b/MeshLib/IO/Legacy/MeshIO.cpp index 753f949196f6057cade265dfe7d8d3ed5c0010fa..7a6626ac5a4a817eb9fd591bf20858877c09d9c9 100644 --- a/MeshLib/IO/Legacy/MeshIO.cpp +++ b/MeshLib/IO/Legacy/MeshIO.cpp @@ -9,11 +9,6 @@ * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license - * - * - * @file MeshIO.cpp - * @date 2012-05-08 - * @author Karsten Rink */ #include "MeshIO.h" diff --git a/MeshLib/IO/VtkIO/VtuInterface-impl.h b/MeshLib/IO/VtkIO/VtuInterface-impl.h index 55e13cdeda7c4188527b3811670b7dd19a5312ad..d004a405272c56a219eccb8ed73fd477d10e631b 100644 --- a/MeshLib/IO/VtkIO/VtuInterface-impl.h +++ b/MeshLib/IO/VtkIO/VtuInterface-impl.h @@ -1,14 +1,10 @@ /** * \file * \author Lars Bilke + * \author Wenqing Wang * \date 2014-09-25 * \brief Implementation of the VtuInterface class. * - * \author Wenqing Wang - * \date 2015-10-19 - * \brief Added parallel output of vtu pieces, and visualisation - * of the vtu picess via pvtu. - * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MeshLib/IO/XDMF/transformData.h b/MeshLib/IO/XDMF/transformData.h index 1d13018045a4dfa3d6df48e82f7e3717712cf6fb..13cf818deabf609a7c14fbdb00914f77ecf5c8c9 100644 --- a/MeshLib/IO/XDMF/transformData.h +++ b/MeshLib/IO/XDMF/transformData.h @@ -25,29 +25,29 @@ namespace MeshLib::IO { /** * \brief Create meta data for attributes used for hdf5 and xdmf - * @param mesh OGS mesh can be mesh or partitionedMesh - * @param n_files specifies the number of files. If greater than 1 it groups the + * \param mesh OGS mesh can be mesh or partitionedMesh + * \param n_files specifies the number of files. If greater than 1 it groups the * data of each process to n_files - * @return vector of meta data + * \return vector of meta data */ std::vector<XdmfHdfData> transformAttributes(MeshLib::Mesh const& mesh, unsigned int n_files); /** * \brief Create meta data for geometry used for hdf5 and xdmf - * @param mesh OGS mesh can be mesh or partitionedMesh - * @param data_ptr Memory location of geometry values. - * @param n_files specifies the number of files. If greater than 1 it groups the + * \param mesh OGS mesh can be mesh or partitionedMesh + * \param data_ptr Memory location of geometry values. + * \param n_files specifies the number of files. If greater than 1 it groups the * data of each process to n_files - * @return Geometry meta data + * \return Geometry meta data */ XdmfHdfData transformGeometry(MeshLib::Mesh const& mesh, double const* data_ptr, unsigned int n_files); /** * \brief Create meta data for topology used for HDF5 and XDMF - * @param values actual topology values to get size and memory location - * @param n_files specifies the number of files. If greater than 1 it groups the + * \param values actual topology values to get size and memory location + * \param n_files specifies the number of files. If greater than 1 it groups the * data of each process to n_files - * @return Topology meta data + * \return Topology meta data */ XdmfHdfData transformTopology(std::vector<int> const& values, unsigned int n_files); @@ -55,18 +55,18 @@ XdmfHdfData transformTopology(std::vector<int> const& values, * \brief Copies all node points into a new vector. Contiguous data used for * writing. Conform with XDMF standard in * https://xdmf.org/index.php/XDMF_Model_and_Format - * @param mesh OGS mesh can be mesh or partitionedMesh - * @return vector containing a copy of the data + * \param mesh OGS mesh can be mesh or partitionedMesh + * \return vector containing a copy of the data */ std::vector<double> transformToXDMFGeometry(MeshLib::Mesh const& mesh); /** * \brief Copies all cells into a new vector. Contiguous data used for writing. * The topology is specific to xdmf because it contains the xdmf cell types!! * See section topology in https://xdmf.org/index.php/XDMF_Model_and_Format - * @param mesh OGS mesh can be mesh or partitionedMesh - * @param offset Local offset to transform local to global cell ID. Offset must + * \param mesh OGS mesh can be mesh or partitionedMesh + * \param offset Local offset to transform local to global cell ID. Offset must * be zero in serial and must be defined for each process in parallel execution. - * @return vector containing a copy of the data + * \return vector containing a copy of the data */ std::vector<int> transformToXDMFTopology(MeshLib::Mesh const& mesh, std::size_t const offset); diff --git a/MeshLib/IO/XDMF/writeXdmf.h b/MeshLib/IO/XDMF/writeXdmf.h index e6a4df81e427106f83d97ce2ef23940134b26469..824521e8bea0b80a7560859fb116f730bd5bd8d0 100644 --- a/MeshLib/IO/XDMF/writeXdmf.h +++ b/MeshLib/IO/XDMF/writeXdmf.h @@ -27,14 +27,14 @@ namespace MeshLib::IO /** * \brief Generator function that creates a function capturing the spatial data * of a mesh Temporal data can later be passed as argument - * @param geometry Metadata for the geometry (points) of the mesh - * @param topology Metadata for the topology of the mesh - * @param variable_attributes Meta data for attributes changing over time - * @param constant_attributes Meta data for attributes NOT changing over time - * @param h5filename Name of the file where the actual data was written - * @param ogs_version OGS Version to be added to XdmfInformation tag - * @param mesh_name Name of the output mesh - * @return unary function with vector of time step values, returning XDMF string + * \param geometry Metadata for the geometry (points) of the mesh + * \param topology Metadata for the topology of the mesh + * \param variable_attributes Meta data for attributes changing over time + * \param constant_attributes Meta data for attributes NOT changing over time + * \param h5filename Name of the file where the actual data was written + * \param ogs_version OGS Version to be added to XdmfInformation tag + * \param mesh_name Name of the output mesh + * \return unary function with vector of time step values, returning XDMF string */ std::function<std::string(std::vector<double>)> write_xdmf( XdmfData const& geometry, XdmfData const& topology, diff --git a/MeshLib/IO/readMeshFromFile.cpp b/MeshLib/IO/readMeshFromFile.cpp index 60d00c74261c2abc7b3a2c9de40514676bddb933..2deeb69b07af099b2eafc4867bf60f975464fdc7 100644 --- a/MeshLib/IO/readMeshFromFile.cpp +++ b/MeshLib/IO/readMeshFromFile.cpp @@ -9,10 +9,6 @@ * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license - * - * @file readMeshFromFile.cpp - * @date 2012-09-27 - * @author Karsten Rink */ #include "readMeshFromFile.h" diff --git a/MeshLib/IO/readMeshFromFile.h b/MeshLib/IO/readMeshFromFile.h index 920ac37991fd245f789260527090ce5f4c869c52..77348c37327cf910956bb6771a6fee9142af8724 100644 --- a/MeshLib/IO/readMeshFromFile.h +++ b/MeshLib/IO/readMeshFromFile.h @@ -9,11 +9,6 @@ * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license - * - * - * @file readMeshFromFile.h - * @date 2012-09-27 - * @author Karsten Rink */ #pragma once diff --git a/MeshLib/Location.h b/MeshLib/Location.h index 2254c2da582db704a7c238c3c8bfcb5dbd7ddd2e..d304242e60a05c6b2661e5b16e15ae8bcd1530a3 100644 --- a/MeshLib/Location.h +++ b/MeshLib/Location.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-04-16 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MeshLib/MeshSearch/MeshElementGrid.cpp b/MeshLib/MeshSearch/MeshElementGrid.cpp index df2f969eaae49f4cdbf05277b0e4363a52bee509..62f80ccdd86f41e34083ff16e020c0a273a72080 100644 --- a/MeshLib/MeshSearch/MeshElementGrid.cpp +++ b/MeshLib/MeshSearch/MeshElementGrid.cpp @@ -1,7 +1,7 @@ /* + * \file * \brief Definition of the class MeshElementGrid. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MeshLib/MeshSearch/MeshElementGrid.h b/MeshLib/MeshSearch/MeshElementGrid.h index 23f69f6cdb21907c9140046a9d879278a064ff57..77903606464434526fd0105cc74bb4c786cd9542 100644 --- a/MeshLib/MeshSearch/MeshElementGrid.h +++ b/MeshLib/MeshSearch/MeshElementGrid.h @@ -1,7 +1,7 @@ /* + * \file * \brief Declaration of the MeshElementGrid class. * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MeshLib/MeshSubset.h b/MeshLib/MeshSubset.h index 5bf01da361cf4f6fdf125c4d8db1c8ac5daa0c69..36af3096c752bc987ef3556cb6ac8de7d1a789db 100644 --- a/MeshLib/MeshSubset.h +++ b/MeshLib/MeshSubset.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-04-16 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/MeshLib/Utils/DuplicateMeshComponents.h b/MeshLib/Utils/DuplicateMeshComponents.h index 6707b21edae79ed5f94c91a153b4314fd47941ff..7dcdc3abe068bb23262efb4732aaefb1d66e2794 100644 --- a/MeshLib/Utils/DuplicateMeshComponents.h +++ b/MeshLib/Utils/DuplicateMeshComponents.h @@ -25,12 +25,12 @@ class Element; std::vector<Node*> copyNodeVector(const std::vector<Node*>& nodes); /** Creates a deep copy of an element vector using the given Node vector. - * @param elements The element vector that should be duplicated. - * @param new_nodes The new node vector used for the duplicated element vector. - * @param node_id_map An optional mapping from the nodes the 'old' elements + * \param elements The element vector that should be duplicated. + * \param new_nodes The new node vector used for the duplicated element vector. + * \param node_id_map An optional mapping from the nodes the 'old' elements * based on to the new nodes. This should be consistent with the original node * vector. - * @return A deep copy of the elements vector using the new nodes vector. + * \return A deep copy of the elements vector using the new nodes vector. */ std::vector<Element*> copyElementVector( std::vector<Element*> const& elements, diff --git a/MeshLib/Utils/GetElementRotationMatrices.h b/MeshLib/Utils/GetElementRotationMatrices.h index 4a06ab888515ddd6b04f6022bb0675c4d0b9c8d0..ddde50656797f844d7e788378ca04e3a8f32d6d1 100644 --- a/MeshLib/Utils/GetElementRotationMatrices.h +++ b/MeshLib/Utils/GetElementRotationMatrices.h @@ -25,10 +25,10 @@ class Element; * local vector to the global coordinate system. If an element is not inclined, * the identity matrix is used as its rotation matrix. * - * @param space_dimension The space dimension. - * @param mesh_dimension The mesh dimension. - * @param elements The mesh elements. - * @return A vector of rotation matrices of given elements. + * \param space_dimension The space dimension. + * \param mesh_dimension The mesh dimension. + * \param elements The mesh elements. + * \return A vector of rotation matrices of given elements. */ std::vector<Eigen::MatrixXd> getElementRotationMatrices( int const space_dimension, int const mesh_dimension, diff --git a/MeshLib/Utils/SetMeshSpaceDimension.h b/MeshLib/Utils/SetMeshSpaceDimension.h index 6d5b1dc33e5c42b03be6e13820c19bb05596895c..810df0fedcd0256a4a3d7c5dd981405f2cd31677 100644 --- a/MeshLib/Utils/SetMeshSpaceDimension.h +++ b/MeshLib/Utils/SetMeshSpaceDimension.h @@ -30,7 +30,7 @@ class Mesh; * with higher dimension can be used to discretise the porous medium matrix * domain. * - * @param meshes All meshes include the bulk mesh and the meshes for boundary + * \param meshes All meshes include the bulk mesh and the meshes for boundary * conditions. */ void setMeshSpaceDimension(std::vector<std::unique_ptr<Mesh>> const& meshes); diff --git a/MeshToolsLib/MeshEditing/AddLayerToMesh.cpp b/MeshToolsLib/MeshEditing/AddLayerToMesh.cpp index ad937901446ea6f7b8d0917eef8dd3b1f00b0659..3296ab5d5ef129b63aa929695dbbdbf2cc4ebebd 100644 --- a/MeshToolsLib/MeshEditing/AddLayerToMesh.cpp +++ b/MeshToolsLib/MeshEditing/AddLayerToMesh.cpp @@ -31,14 +31,14 @@ namespace MeshToolsLib /** Extrudes point, line, triangle or quad elements to its higher dimensional * versions, i.e. line, quad, prism, hexahedron. * - * @param subsfc_nodes the nodes the elements are based on - * @param sfc_elem the element of the surface that will be extruded - * @param sfc_to_subsfc_id_map relation between the surface nodes of the surface + * \param subsfc_nodes the nodes the elements are based on + * \param sfc_elem the element of the surface that will be extruded + * \param sfc_to_subsfc_id_map relation between the surface nodes of the surface * element and the ids of the nodes of the subsurface mesh - * @param subsfc_sfc_id_map mapping of the surface nodes of the current mesh + * \param subsfc_sfc_id_map mapping of the surface nodes of the current mesh * to the surface nodes of the extruded mesh * - * @return extruded element (point -> line, line -> quad, tri -> prism, quad -> + * \return extruded element (point -> line, line -> quad, tri -> prism, quad -> * hexahedron) */ MeshLib::Element* extrudeElement( diff --git a/MeshToolsLib/MeshEditing/FlipElements.h b/MeshToolsLib/MeshEditing/FlipElements.h index d1ba4a91d6844212b3ef0721b7d6e6c80ea858d4..ad4466f96ab04fb3a1ff3de364f63451adf78acd 100644 --- a/MeshToolsLib/MeshEditing/FlipElements.h +++ b/MeshToolsLib/MeshEditing/FlipElements.h @@ -28,9 +28,9 @@ namespace MeshToolsLib * Creates a copy of an 1d / 2d element where the node order is reversed, * such that the direction of a line changes and normals of 2D elements * changes its sign. - * @param elem original element - * @param nodes node vector used for the copy of the element - * @return a flipped copy of the element + * \param elem original element + * \param nodes node vector used for the copy of the element + * \return a flipped copy of the element */ std::unique_ptr<MeshLib::Element> createFlippedElement( MeshLib::Element const& elem, std::vector<MeshLib::Node*> const& nodes); @@ -39,8 +39,8 @@ std::unique_ptr<MeshLib::Element> createFlippedElement( * Creates a copy of a 1d / 2d mesh where the node order of all elements * is reversed such that the direction of lines changes and normals of * 2D elements changes their sign. - * @param mesh input mesh - * @return a flipped copy of the input mesh + * \param mesh input mesh + * \return a flipped copy of the input mesh */ std::unique_ptr<MeshLib::Mesh> createFlippedMesh(MeshLib::Mesh const& mesh); diff --git a/MeshToolsLib/MeshEditing/RemoveMeshComponents.h b/MeshToolsLib/MeshEditing/RemoveMeshComponents.h index 3cdff0b6b46a4d4854f9648e75e1f4646ceb659b..9e1286ce1f99ea9eb07985c60622e3198bfdf623 100644 --- a/MeshToolsLib/MeshEditing/RemoveMeshComponents.h +++ b/MeshToolsLib/MeshEditing/RemoveMeshComponents.h @@ -26,10 +26,10 @@ namespace MeshToolsLib /** * Removes mesh elements and returns a new mesh object. The original mesh is * kept unchanged. - * @param mesh an original mesh whose elements are removed - * @param removed_element_ids a vector of element indices to be removed - * @param new_mesh_name a new mesh name - * @return a new mesh object + * \param mesh an original mesh whose elements are removed + * \param removed_element_ids a vector of element indices to be removed + * \param new_mesh_name a new mesh name + * \return a new mesh object */ MeshLib::Mesh* removeElements( const MeshLib::Mesh& mesh, @@ -39,10 +39,10 @@ MeshLib::Mesh* removeElements( /** * Removes the mesh nodes (and connected elements) given in the nodes-list from * the mesh. - * @param mesh an original mesh whose elements are removed - * @param del_nodes_idx a vector of node indices to be removed - * @param new_mesh_name a new mesh name - * @return a new mesh object + * \param mesh an original mesh whose elements are removed + * \param del_nodes_idx a vector of node indices to be removed + * \param new_mesh_name a new mesh name + * \return a new mesh object */ MeshLib::Mesh* removeNodes(const MeshLib::Mesh& mesh, const std::vector<std::size_t>& del_nodes_idx, diff --git a/MeshToolsLib/MeshEditing/moveMeshNodes.h b/MeshToolsLib/MeshEditing/moveMeshNodes.h index 7c2209ace13190fdef531aa216363d1c35aacbca..e81aca8a1f77d07fdb83f301e5b95eb73b673200 100644 --- a/MeshToolsLib/MeshEditing/moveMeshNodes.h +++ b/MeshToolsLib/MeshEditing/moveMeshNodes.h @@ -1,10 +1,9 @@ /** - * @file moveMeshNodes.h - * @author Thomas Fischer - * @date Feb 03, 2014 - * @brief Functionality to move mesh nodes using a given displacement vec. - * * \file + * \author Thomas Fischer + * \date Feb 03, 2014 + * \brief Functionality to move mesh nodes using a given displacement vec. + * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. @@ -26,9 +25,9 @@ namespace MeshToolsLib * The function iterates over all mesh nodes between the * begin and the end iterator and moves them using the * given displacement. - * @param begin begin iterator - * @param end end iterator - * @param displacement the displacement to use + * \param begin begin iterator + * \param end end iterator + * \param displacement the displacement to use */ template <typename Iterator> void moveMeshNodes(Iterator begin, diff --git a/MeshToolsLib/MeshGenerators/MeshGenerator.h b/MeshToolsLib/MeshGenerators/MeshGenerator.h index 36a8e417b820e7d247e302c305be2f5b14b3df08..44e147c667f6d686a14628043d23a7a129cf366b 100644 --- a/MeshToolsLib/MeshGenerators/MeshGenerator.h +++ b/MeshToolsLib/MeshGenerators/MeshGenerator.h @@ -31,9 +31,9 @@ namespace MeshGenerator /** * Generate regularly placed mesh nodes in 3D spaces - * @param vec_xyz_coords a vector of coordinates in x,y,z directions - * @param origin coordinates of the left-most point - * @return a vector of created mesh nodes + * \param vec_xyz_coords a vector of coordinates in x,y,z directions + * \param origin coordinates of the left-most point + * \return a vector of created mesh nodes */ std::vector<MeshLib::Node*> generateRegularNodes( const std::vector<const std::vector<double>*>& vec_xyz_coords, @@ -41,9 +41,9 @@ std::vector<MeshLib::Node*> generateRegularNodes( /** * Generate regularly placed mesh nodes in 1D space - * @param vec_x_coords a vector of x coordinates - * @param origin coordinates of the left-most point - * @return a vector of created mesh nodes + * \param vec_x_coords a vector of x coordinates + * \param origin coordinates of the left-most point + * \return a vector of created mesh nodes */ std::vector<MeshLib::Node*> generateRegularNodes( const std::vector<double>& vec_x_coords, @@ -51,10 +51,10 @@ std::vector<MeshLib::Node*> generateRegularNodes( /** * Generate regularly placed mesh nodes in 1D space - * @param vec_x_coords a vector of x coordinates - * @param vec_y_coords a vector of y coordinates - * @param origin coordinates of the left-most point - * @return a vector of created mesh nodes + * \param vec_x_coords a vector of x coordinates + * \param vec_y_coords a vector of y coordinates + * \param origin coordinates of the left-most point + * \return a vector of created mesh nodes */ std::vector<MeshLib::Node*> generateRegularNodes( std::vector<double>& vec_x_coords, @@ -63,11 +63,11 @@ std::vector<MeshLib::Node*> generateRegularNodes( /** * Generate regularly placed mesh nodes in 1D space - * @param vec_x_coords a vector of x coordinates - * @param vec_y_coords a vector of y coordinates - * @param vec_z_coords a vector of z coordinates - * @param origin coordinates of the left-most point - * @return a vector of created mesh nodes + * \param vec_x_coords a vector of x coordinates + * \param vec_y_coords a vector of y coordinates + * \param vec_z_coords a vector of z coordinates + * \param origin coordinates of the left-most point + * \return a vector of created mesh nodes */ std::vector<MeshLib::Node*> generateRegularNodes( std::vector<double>& vec_x_coords, @@ -77,10 +77,10 @@ std::vector<MeshLib::Node*> generateRegularNodes( /** * Generate regularly placed mesh nodes in 3D spaces - * @param n_cells an array of the number of cells in x,y,z directions - * @param cell_size an array of cell sizes in x,y,z directions - * @param origin coordinates of the left-most point - * @return a vector of created mesh nodes + * \param n_cells an array of the number of cells in x,y,z directions + * \param cell_size an array of cell sizes in x,y,z directions + * \param origin coordinates of the left-most point + * \return a vector of created mesh nodes */ std::vector<MeshLib::Node*> generateRegularNodes( const std::array<unsigned, 3>& n_cells, diff --git a/MeshToolsLib/MeshGenerators/VoxelGridFromLayeredMeshes.h b/MeshToolsLib/MeshGenerators/VoxelGridFromLayeredMeshes.h index 576d66c788d6d86e31966c1a0797bdc006bfdb0e..346b33068f18483e4f4c5156564d1bf57005c0f7 100644 --- a/MeshToolsLib/MeshGenerators/VoxelGridFromLayeredMeshes.h +++ b/MeshToolsLib/MeshGenerators/VoxelGridFromLayeredMeshes.h @@ -31,13 +31,13 @@ namespace MeshToolsLib::MeshGenerators::VoxelFromLayeredMeshes /** * Constructs a VoxelGrid with a specified resolution of a list of * layered meshes. - * @param extent The axis-aligned boundary-box (AABB) which is initially + * \param extent The axis-aligned boundary-box (AABB) which is initially * defined. - * @param layers Containing all the meshes that will be used + * \param layers Containing all the meshes that will be used * to create the VoxelGrid. - * @param cellsize Contains the resolution of the Voxel (i.e. + * \param cellsize Contains the resolution of the Voxel (i.e. * length in x-,y-,z-directions) - * @param dilate A flag to set dilate. If dilate is True all Voxels which + * \param dilate A flag to set dilate. If dilate is True all Voxels which * are not fully covered by the meshes are included in the resulting * VoxelGrid. */ diff --git a/MeshToolsLib/MeshQuality/MeshValidation.cpp b/MeshToolsLib/MeshQuality/MeshValidation.cpp index 5488ab8822b2e50b90a57c34d2c243daebaea7f4..7381bacc4f9d94f8a3360b3fe812a8fa6bbcaf41 100644 --- a/MeshToolsLib/MeshQuality/MeshValidation.cpp +++ b/MeshToolsLib/MeshQuality/MeshValidation.cpp @@ -31,10 +31,10 @@ namespace MeshToolsLib /** Finds all surface elements that can be reached from element. All elements * that are found in this way are marked in the global sfc_idx vector using the * current_index. - * @param element The mesh element from which the search is started - * @param sfc_idx The global index vector notifying to which surface elements + * \param element The mesh element from which the search is started + * \param sfc_idx The global index vector notifying to which surface elements * belong - * @param current_index The index that all elements reachable from element will + * \param current_index The index that all elements reachable from element will * be assigned in sfc_idx */ static void trackSurface(MeshLib::Element const* const element, diff --git a/MeshToolsLib/convertMeshToGeo.h b/MeshToolsLib/convertMeshToGeo.h index 4b8a5865c129d4efb151ebbddcbcdf7a75dbbd76..c8b93edec0dcd2d86bfd3c7275567ecd2d6cede6 100644 --- a/MeshToolsLib/convertMeshToGeo.h +++ b/MeshToolsLib/convertMeshToGeo.h @@ -43,10 +43,10 @@ bool convertMeshToGeo(const MeshLib::Mesh& mesh, /** * Converts a surface into a triangular mesh - * @param sfc Surface object - * @param mesh_name New mesh name - * @param eps Minimum distance for nodes not to be collapsed - * @return a pointer to a converted mesh object. nullptr is returned if the + * \param sfc Surface object + * \param mesh_name New mesh name + * \param eps Minimum distance for nodes not to be collapsed + * \return a pointer to a converted mesh object. nullptr is returned if the * conversion fails. */ MeshLib::Mesh* convertSurfaceToMesh( diff --git a/NumLib/Assembler/SerialExecutor.h b/NumLib/Assembler/SerialExecutor.h index e7565fe8ede3ed0821b3c6624da3c4525c53b3e1..c5f9dd5cc7a023dd4cabd766e5a0285d1cca3eca 100644 --- a/NumLib/Assembler/SerialExecutor.h +++ b/NumLib/Assembler/SerialExecutor.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-04-16 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/DOF/ComponentGlobalIndexDict.h b/NumLib/DOF/ComponentGlobalIndexDict.h index 4d2335a5b52aa3e91d203b60329257c34a29f707..9d0450aea55abaaf6e19885bf4babb4b01791fdc 100644 --- a/NumLib/DOF/ComponentGlobalIndexDict.h +++ b/NumLib/DOF/ComponentGlobalIndexDict.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-04-16 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/DOF/ComputeSparsityPattern.h b/NumLib/DOF/ComputeSparsityPattern.h index ebd5e73f30c7ac85fdba0321136a216ceca70018..a300879db7a8d073fbf3a0d07742dc27679b4fe6 100644 --- a/NumLib/DOF/ComputeSparsityPattern.h +++ b/NumLib/DOF/ComputeSparsityPattern.h @@ -24,13 +24,13 @@ namespace NumLib class LocalToGlobalIndexMap; /** - * @brief Computes a sparsity pattern for the given inputs. + * \brief Computes a sparsity pattern for the given inputs. * - * @param dof_table maps mesh nodes to global indices - * @param mesh mesh for which the two parameters above are + * \param dof_table maps mesh nodes to global indices + * \param mesh mesh for which the two parameters above are * defined * - * @return The computed sparsity pattern. + * \return The computed sparsity pattern. */ GlobalSparsityPattern computeSparsityPattern( LocalToGlobalIndexMap const& dof_table, MeshLib::Mesh const& mesh); diff --git a/NumLib/DOF/MeshComponentMap.cpp b/NumLib/DOF/MeshComponentMap.cpp index 9fda517e0afbebc17f5c5a37140795510bca97f1..1b4219f74f5d8f530ba2488797b93defc3fadde6 100644 --- a/NumLib/DOF/MeshComponentMap.cpp +++ b/NumLib/DOF/MeshComponentMap.cpp @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-04-16 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/DOF/MeshComponentMap.h b/NumLib/DOF/MeshComponentMap.h index 7aab973f96b694a0b1fc9e91643879d7344aeaed..362c4964192e09b6e395a71f2754efa23ad10bd9 100644 --- a/NumLib/DOF/MeshComponentMap.h +++ b/NumLib/DOF/MeshComponentMap.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-04-16 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/Fem/CoordinatesMapping/NaturalCoordinatesMapping.h b/NumLib/Fem/CoordinatesMapping/NaturalCoordinatesMapping.h index bd5f3192ceebfda108c76e18f32d6fd3edbb72dd..352df90cf440e0a334a3f93bfc368d64c1b73673 100644 --- a/NumLib/Fem/CoordinatesMapping/NaturalCoordinatesMapping.h +++ b/NumLib/Fem/CoordinatesMapping/NaturalCoordinatesMapping.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. @@ -40,8 +40,8 @@ void naturalCoordinatesMappingComputeShapeMatrices(const MeshLib::Element& ele, * e.g. line elements in 2D space. Details of the mapping method can be found in * \cite Kolditz2001 . * - * @tparam T_SHAPE_FUNC Shape function class - * @tparam T_SHAPE_MATRICES Shape matrices class + * \tparam T_SHAPE_FUNC Shape function class + * \tparam T_SHAPE_MATRICES Shape matrices class */ template <class T_SHAPE_FUNC, class T_SHAPE_MATRICES> struct NaturalCoordinatesMapping @@ -49,11 +49,11 @@ struct NaturalCoordinatesMapping /** * compute all mapping matrices at the given location in natural coordinates * - * @param ele Mesh element object - * @param natural_pt Location in natural coordinates (r,s,t) - * @param shapemat Shape matrix data where calculated shape + * \param ele Mesh element object + * \param natural_pt Location in natural coordinates (r,s,t) + * \param shapemat Shape matrix data where calculated shape * functions are stored - * @param global_dim Global dimension + * \param global_dim Global dimension */ static void computeShapeMatrices(const MeshLib::Element& ele, const double* natural_pt, @@ -68,12 +68,12 @@ struct NaturalCoordinatesMapping * compute specified mapping matrices at the given location in natural * coordinates * - * @tparam T_SHAPE_MATRIX_TYPE Mapping matrix types to be calculated - * @param ele Mesh element object - * @param natural_pt Location in natural coordinates (r,s,t) - * @param shapemat Shape matrix data where calculated shape + * \tparam T_SHAPE_MATRIX_TYPE Mapping matrix types to be calculated + * \param ele Mesh element object + * \param natural_pt Location in natural coordinates (r,s,t) + * \param shapemat Shape matrix data where calculated shape * functions are stored - * @param global_dim Global dimension + * \param global_dim Global dimension */ template <ShapeMatrixType T_SHAPE_MATRIX_TYPE> static void computeShapeMatrices(const MeshLib::Element& ele, diff --git a/NumLib/Fem/CoordinatesMapping/ShapeMatrices-impl.h b/NumLib/Fem/CoordinatesMapping/ShapeMatrices-impl.h index ecea053c494f64d51e5d659da210db0b10e1723b..abd2e6d73a7b5082150668807be2289740279b80 100644 --- a/NumLib/Fem/CoordinatesMapping/ShapeMatrices-impl.h +++ b/NumLib/Fem/CoordinatesMapping/ShapeMatrices-impl.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/Fem/CoordinatesMapping/ShapeMatrices.h b/NumLib/Fem/CoordinatesMapping/ShapeMatrices.h index 5e0cbff7e4a2d122cd631929280f220025e83941..d8b08c214a322bdd65ad415b2e70554b47f5c348 100644 --- a/NumLib/Fem/CoordinatesMapping/ShapeMatrices.h +++ b/NumLib/Fem/CoordinatesMapping/ShapeMatrices.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/Fem/FiniteElement/C0IsoparametricElements.h b/NumLib/Fem/FiniteElement/C0IsoparametricElements.h index 99a2dd8820642ec00b8221ea96a28bc9297e58e9..3f25ad53f32f69aa8627e63cd75b070a86aeea70 100644 --- a/NumLib/Fem/FiniteElement/C0IsoparametricElements.h +++ b/NumLib/Fem/FiniteElement/C0IsoparametricElements.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/Fem/FiniteElement/TemplateIsoparametric.h b/NumLib/Fem/FiniteElement/TemplateIsoparametric.h index 7d0bb3251b9b42b4fa6eab8273cecb478eb28a27..fb6df900fb4eab71041769ab0f5939ee9e325db3 100644 --- a/NumLib/Fem/FiniteElement/TemplateIsoparametric.h +++ b/NumLib/Fem/FiniteElement/TemplateIsoparametric.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/Fem/Integration/IntegrationGaussLegendreTri.h b/NumLib/Fem/Integration/IntegrationGaussLegendreTri.h index 76c6604f36962db7f0e3fa14e714a5b25d729831..a3c583279ba6e5368e4cbc835fd83896ca202644 100644 --- a/NumLib/Fem/Integration/IntegrationGaussLegendreTri.h +++ b/NumLib/Fem/Integration/IntegrationGaussLegendreTri.h @@ -2,7 +2,6 @@ * \file * \author Norihiro Watanabe * \date 2013-08-13 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/NumLib/Fem/ShapeFunction/ShapeQuad4-impl.h b/NumLib/Fem/ShapeFunction/ShapeQuad4-impl.h index a7264b12e4c4780d5766c785a744f9e02bf77233..5703e05b4207ed51fac049e75087ece34bab28c6 100644 --- a/NumLib/Fem/ShapeFunction/ShapeQuad4-impl.h +++ b/NumLib/Fem/ShapeFunction/ShapeQuad4-impl.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/Fem/ShapeFunction/ShapeQuad4.h b/NumLib/Fem/ShapeFunction/ShapeQuad4.h index 12967b33a04b23870296ff272e9828bccc3df44d..c109e8baffd6ae0f2adad1a94a984bc163abdf98 100644 --- a/NumLib/Fem/ShapeFunction/ShapeQuad4.h +++ b/NumLib/Fem/ShapeFunction/ShapeQuad4.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/Fem/ShapeFunction/ShapeTri3-impl.h b/NumLib/Fem/ShapeFunction/ShapeTri3-impl.h index e5f26e655f4d8cf99ae072b9ed6f3ea4dbe3b55f..3b8344acf009db8a3c223488daa3a5178106a306 100644 --- a/NumLib/Fem/ShapeFunction/ShapeTri3-impl.h +++ b/NumLib/Fem/ShapeFunction/ShapeTri3-impl.h @@ -2,7 +2,6 @@ * \file * \author Norihiro Watanabe * \date 2013-08-13 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/NumLib/Fem/ShapeFunction/ShapeTri3.h b/NumLib/Fem/ShapeFunction/ShapeTri3.h index ee68863448ab18e7ab2afb86bd5583ebe4f261f6..98d33a3d2f79274d654e169dc9701ef6d14814bc 100644 --- a/NumLib/Fem/ShapeFunction/ShapeTri3.h +++ b/NumLib/Fem/ShapeFunction/ShapeTri3.h @@ -2,7 +2,6 @@ * \file * \author Norihiro Watanabe * \date 2013-08-13 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/NumLib/Function/ISpatialFunction.h b/NumLib/Function/ISpatialFunction.h index a3f6b5c693052c5b5a3acba7c495cec10f40daec..4232cd13ceb974ab0d8dbb8ad75ee9fbd3f11c59 100644 --- a/NumLib/Function/ISpatialFunction.h +++ b/NumLib/Function/ISpatialFunction.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-08-13 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/ODESolver/ODESolver.dox b/NumLib/ODESolver/ODESolver.dox index b85ea34f41efc99538f0e4a10ddf29cc77d04dac..b7065d1aa5ffdb6bd1b5b45ccae24e0547554453 100644 --- a/NumLib/ODESolver/ODESolver.dox +++ b/NumLib/ODESolver/ODESolver.dox @@ -1,4 +1,5 @@ /*! \defgroup ODESolver ODE Solver Library + * \file This ODE solver library has been designed with an implicit first-order quasilinear ODE in mind. However, it is in principle not restricted to such a diff --git a/NumLib/ODESolver/TimeDiscretization.cpp b/NumLib/ODESolver/TimeDiscretization.cpp index 512b3a7769f6772f25632f27e4f3f22f8dcd1d96..21765469c005160c5a85a38d07d299574f5a94b6 100644 --- a/NumLib/ODESolver/TimeDiscretization.cpp +++ b/NumLib/ODESolver/TimeDiscretization.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on March 31, 2017, 10:30 AM */ diff --git a/NumLib/ODESolver/TimeDiscretization.h b/NumLib/ODESolver/TimeDiscretization.h index 1469c910e570ff8df07826780e3b346bc8b1c204..196fa67a2f84c0be75643e29f031d2bb09e0e471 100644 --- a/NumLib/ODESolver/TimeDiscretization.h +++ b/NumLib/ODESolver/TimeDiscretization.h @@ -22,10 +22,10 @@ namespace NumLib * Compute and return the relative change of solutions between two * successive time steps by \f$ e_n = \|u^{n+1}-u^{n}\|/\|u^{n+1}\| \f$. * - * @param x The current solution - * @param x_old The previous solution - * @param norm_type The norm type of global vector - * @return \f$ e_n = \|u^{n+1}-u^{n}\|/\|u^{n+1}\| \f$. + * \param x The current solution + * \param x_old The previous solution + * \param norm_type The norm type of global vector + * \return \f$ e_n = \|u^{n+1}-u^{n}\|/\|u^{n+1}\| \f$. * */ double computeRelativeChangeFromPreviousTimestep( diff --git a/NumLib/TimeStepping/Algorithms/CreateEvolutionaryPIDcontroller.cpp b/NumLib/TimeStepping/Algorithms/CreateEvolutionaryPIDcontroller.cpp index d3d487af038c9da4edc029a243fa08da07d2efae..b80498fee378235e2aab21e804fe9dc0d58c31de 100644 --- a/NumLib/TimeStepping/Algorithms/CreateEvolutionaryPIDcontroller.cpp +++ b/NumLib/TimeStepping/Algorithms/CreateEvolutionaryPIDcontroller.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on June 26, 2017, 4:43 PM */ diff --git a/NumLib/TimeStepping/Algorithms/CreateEvolutionaryPIDcontroller.h b/NumLib/TimeStepping/Algorithms/CreateEvolutionaryPIDcontroller.h index 8b13819ed8cc70c1b7385a64a9267a959868d5f2..f22181680accce2aee026f2ea34351c7089456ea 100644 --- a/NumLib/TimeStepping/Algorithms/CreateEvolutionaryPIDcontroller.h +++ b/NumLib/TimeStepping/Algorithms/CreateEvolutionaryPIDcontroller.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on June 26, 2017, 4:43 PM */ diff --git a/NumLib/TimeStepping/Algorithms/CreateFixedTimeStepping.cpp b/NumLib/TimeStepping/Algorithms/CreateFixedTimeStepping.cpp index a0947c45065c7ad941cc7b1f1d5bda4bcac85e3c..ff7c7c6d19a33d3f1d66a221735252edc0b909a3 100644 --- a/NumLib/TimeStepping/Algorithms/CreateFixedTimeStepping.cpp +++ b/NumLib/TimeStepping/Algorithms/CreateFixedTimeStepping.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on June 26, 2017, 5:03 PM */ diff --git a/NumLib/TimeStepping/Algorithms/CreateFixedTimeStepping.h b/NumLib/TimeStepping/Algorithms/CreateFixedTimeStepping.h index ac125d0fba5798cb33328080bda9b0887ca4fcd0..444888b0fe636bbfa549f3b9339e90f4de720561 100644 --- a/NumLib/TimeStepping/Algorithms/CreateFixedTimeStepping.h +++ b/NumLib/TimeStepping/Algorithms/CreateFixedTimeStepping.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on June 26, 2017, 5:02 PM */ diff --git a/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.cpp b/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.cpp index 7e15508ba07fc72aa73a64ecd281368eb7c11303..6c37736e5098b882ac187463bff855372af739d5 100644 --- a/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.cpp +++ b/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on March 31, 2017, 4:13 PM */ diff --git a/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.h b/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.h index 3b4a8e82bd0258ecc09770d8b69f95e5d58ac6bc..9238b3e4e866b26d071dd56175278667bc114b20 100644 --- a/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.h +++ b/NumLib/TimeStepping/Algorithms/EvolutionaryPIDcontroller.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on March 31, 2017, 4:13 PM */ diff --git a/NumLib/TimeStepping/Algorithms/FixedTimeStepping.cpp b/NumLib/TimeStepping/Algorithms/FixedTimeStepping.cpp index facd7079568ca5d7b404f27dab64e27e722242c2..bfd848d960037908dd87be4189a05ce55f6ebade 100644 --- a/NumLib/TimeStepping/Algorithms/FixedTimeStepping.cpp +++ b/NumLib/TimeStepping/Algorithms/FixedTimeStepping.cpp @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2012-08-03 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/NumLib/TimeStepping/CreateTimeStepper.cpp b/NumLib/TimeStepping/CreateTimeStepper.cpp index a79ab793f63b0b711c8580fa7a7093f4772b3af1..993582ef8ff4b432105497ec21537b1f795a35f0 100644 --- a/NumLib/TimeStepping/CreateTimeStepper.cpp +++ b/NumLib/TimeStepping/CreateTimeStepper.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on May 2, 2017, 12:18 PM */ diff --git a/NumLib/TimeStepping/CreateTimeStepper.h b/NumLib/TimeStepping/CreateTimeStepper.h index 317912738dcbfde501df6404eaf99fbe78ad39b8..bf582927bacdbab6abbecc474f44533d91438873 100644 --- a/NumLib/TimeStepping/CreateTimeStepper.h +++ b/NumLib/TimeStepping/CreateTimeStepper.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on May 2, 2017, 12:18 PM */ diff --git a/NumLib/TimeStepping/TimeStep.h b/NumLib/TimeStepping/TimeStep.h index 9e236b1aacc3a53e5c24b13d348dee1a2bd40b2b..b1d96a89670f9a54f1e96535390569747dfb6bb2 100644 --- a/NumLib/TimeStepping/TimeStep.h +++ b/NumLib/TimeStepping/TimeStep.h @@ -1,8 +1,8 @@ /** + * \file * \author Norihiro Watanabe * \date 2012-08-03 * - * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/ProcessLib/BoundaryConditionAndSourceTerm/Python/PythonSourceTermLocalAssemblerInterface.h b/ProcessLib/BoundaryConditionAndSourceTerm/Python/PythonSourceTermLocalAssemblerInterface.h index e2c8c2d0c9cd3d9ce2a4a3f0d083947b4a0e52bf..86ee623627e98fd320f8b3121b03246ce949858b 100644 --- a/ProcessLib/BoundaryConditionAndSourceTerm/Python/PythonSourceTermLocalAssemblerInterface.h +++ b/ProcessLib/BoundaryConditionAndSourceTerm/Python/PythonSourceTermLocalAssemblerInterface.h @@ -1,4 +1,3 @@ - /** * \file * \copyright diff --git a/ProcessLib/BoundaryConditionAndSourceTerm/SourceTermIntegrationPointData.h b/ProcessLib/BoundaryConditionAndSourceTerm/SourceTermIntegrationPointData.h index c29c642d6ab0e73e275f8f717e1f65fd68884f4a..45af6206e6007e0b69114e818a49ecc8947bd6f1 100644 --- a/ProcessLib/BoundaryConditionAndSourceTerm/SourceTermIntegrationPointData.h +++ b/ProcessLib/BoundaryConditionAndSourceTerm/SourceTermIntegrationPointData.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file */ #pragma once diff --git a/ProcessLib/CoupledSolutionsForStaggeredScheme.cpp b/ProcessLib/CoupledSolutionsForStaggeredScheme.cpp index 489c2351caf8a91f6cc93694eca779e4d1aad89f..7190e84650af365b280a080166799a24eda1678a 100644 --- a/ProcessLib/CoupledSolutionsForStaggeredScheme.cpp +++ b/ProcessLib/CoupledSolutionsForStaggeredScheme.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 7, 2016, 12:14 PM */ diff --git a/ProcessLib/CoupledSolutionsForStaggeredScheme.h b/ProcessLib/CoupledSolutionsForStaggeredScheme.h index bb872a9471cb40390b6dc9ab2b4edfd819eb06a1..0393bd5586049d3615e3fd4325fc616365a45a3e 100644 --- a/ProcessLib/CoupledSolutionsForStaggeredScheme.h +++ b/ProcessLib/CoupledSolutionsForStaggeredScheme.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 7, 2016, 12:14 PM */ diff --git a/ProcessLib/HT/HTLocalAssemblerInterface.h b/ProcessLib/HT/HTLocalAssemblerInterface.h index 57eae99628f62995b556323273b525ff6ec5b51a..93255472ab70de99c2c2ea186f89d2f7b48008b4 100644 --- a/ProcessLib/HT/HTLocalAssemblerInterface.h +++ b/ProcessLib/HT/HTLocalAssemblerInterface.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on October 11, 2017, 1:35 PM */ diff --git a/ProcessLib/HT/MonolithicHTFEM.h b/ProcessLib/HT/MonolithicHTFEM.h index 5d453f4fd8dfcce39c989a50af7d96156aeea5dc..400364adc15d2b1f0b5f075795cc3469ca4bd425 100644 --- a/ProcessLib/HT/MonolithicHTFEM.h +++ b/ProcessLib/HT/MonolithicHTFEM.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on October 11, 2017, 2:33 PM */ diff --git a/ProcessLib/HT/StaggeredHTFEM-impl.h b/ProcessLib/HT/StaggeredHTFEM-impl.h index fca14b7704edb00da889e36df473f5b78fe0d5b5..51112928f77211cdf7d1062d8df2673ea3e1ecba 100644 --- a/ProcessLib/HT/StaggeredHTFEM-impl.h +++ b/ProcessLib/HT/StaggeredHTFEM-impl.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on October 13, 2017, 3:52 PM */ diff --git a/ProcessLib/HT/StaggeredHTFEM.h b/ProcessLib/HT/StaggeredHTFEM.h index 68c81961e788cee9ccc65c4ef60b139a86e388b3..7248739059e89450e30948c593558e443e22e58e 100644 --- a/ProcessLib/HT/StaggeredHTFEM.h +++ b/ProcessLib/HT/StaggeredHTFEM.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on October 11, 2017, 1:42 PM */ diff --git a/ProcessLib/HeatTransportBHE/BHE/MeshUtils.h b/ProcessLib/HeatTransportBHE/BHE/MeshUtils.h index 73aaf5e94e00eeb7537417347d9c7b94f2038d8d..b908ba35f03071b54029380c3f1423cce83a8634 100644 --- a/ProcessLib/HeatTransportBHE/BHE/MeshUtils.h +++ b/ProcessLib/HeatTransportBHE/BHE/MeshUtils.h @@ -43,7 +43,7 @@ struct BHEMeshData /** * get data about fracture and matrix elements/nodes from a mesh * - * @param mesh A mesh which includes BHE elements, i.e. 1-dimensional + * \param mesh A mesh which includes BHE elements, i.e. 1-dimensional * elements. It is assumed that elements forming a BHE have a distinct * material ID. */ diff --git a/ProcessLib/HydroMechanics/HydroMechanicsFEM-impl.h b/ProcessLib/HydroMechanics/HydroMechanicsFEM-impl.h index c00850caae8e7405e2040103230703b2c11593c8..0b0d6f16803c1649ed480066edae149b45c916a3 100644 --- a/ProcessLib/HydroMechanics/HydroMechanicsFEM-impl.h +++ b/ProcessLib/HydroMechanics/HydroMechanicsFEM-impl.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on November 29, 2017, 2:03 PM */ diff --git a/ProcessLib/LIE/Common/MeshUtils.h b/ProcessLib/LIE/Common/MeshUtils.h index ba118349685ea00260803d9f39d8c791b1090dfb..0a2b62b795c3e228232fffb5a6e03f0bae584b6f 100644 --- a/ProcessLib/LIE/Common/MeshUtils.h +++ b/ProcessLib/LIE/Common/MeshUtils.h @@ -25,20 +25,20 @@ namespace LIE /** * get data about fracture and matrix elements/nodes from a mesh * - * @param mesh A mesh which includes fracture elements, i.e. lower-dimensional + * \param mesh A mesh which includes fracture elements, i.e. lower-dimensional * elements. It is assumed that elements forming a fracture have a distinct * material ID. - * @param vec_matrix_elements a vector of matrix elements - * @param vec_fracture_mat_IDs fracture material IDs found in the mesh - * @param vec_fracture_elements a vector of fracture elements (grouped by + * \param vec_matrix_elements a vector of matrix elements + * \param vec_fracture_mat_IDs fracture material IDs found in the mesh + * \param vec_fracture_elements a vector of fracture elements (grouped by * fracture IDs) - * @param vec_fracture_matrix_elements a vector of fracture elements and matrix + * \param vec_fracture_matrix_elements a vector of fracture elements and matrix * elements connecting to the fracture (grouped by fracture IDs) - * @param vec_fracture_nodes a vector of fracture element nodes (grouped by + * \param vec_fracture_nodes a vector of fracture element nodes (grouped by * fracture IDs) - * @param vec_branch_nodeID_matIDs a vector of branch node IDs found in the + * \param vec_branch_nodeID_matIDs a vector of branch node IDs found in the * mesh (and corresponding fracture material IDs) - * @param vec_junction_nodeID_matIDs a vector of junction node IDs found in the + * \param vec_junction_nodeID_matIDs a vector of junction node IDs found in the * mesh (and corresponding fracture material IDs) */ void getFractureMatrixDataInMesh( diff --git a/ProcessLib/LiquidFlow/CreateLiquidFlowProcess.cpp b/ProcessLib/LiquidFlow/CreateLiquidFlowProcess.cpp index bc0d9112b22ca43bcb4c6f4ebc35658148ebf7be..c01dfc07c4cfa4a695d09f7deaed0ef467195f32 100644 --- a/ProcessLib/LiquidFlow/CreateLiquidFlowProcess.cpp +++ b/ProcessLib/LiquidFlow/CreateLiquidFlowProcess.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 19, 2016, 1:30 PM */ diff --git a/ProcessLib/LiquidFlow/CreateLiquidFlowProcess.h b/ProcessLib/LiquidFlow/CreateLiquidFlowProcess.h index 32ff5e7e818cff2c6174c685f3da5e84d22f2487..86944849a79bbae47e7fb795bd86beac68157cb0 100644 --- a/ProcessLib/LiquidFlow/CreateLiquidFlowProcess.h +++ b/ProcessLib/LiquidFlow/CreateLiquidFlowProcess.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 19, 2016, 1:30 PM */ diff --git a/ProcessLib/LiquidFlow/LiquidFlowLocalAssembler-impl.h b/ProcessLib/LiquidFlow/LiquidFlowLocalAssembler-impl.h index 636a49c86386e7ae2ea41430daef77754266ef77..114e8234c6133eecafbf650373114dfa6c0083f5 100644 --- a/ProcessLib/LiquidFlow/LiquidFlowLocalAssembler-impl.h +++ b/ProcessLib/LiquidFlow/LiquidFlowLocalAssembler-impl.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 19, 2016, 2:28 PM */ diff --git a/ProcessLib/LiquidFlow/LiquidFlowLocalAssembler.h b/ProcessLib/LiquidFlow/LiquidFlowLocalAssembler.h index 5c26200d8cc5435bd599f98d42a9f31c74489426..a0f05acf2637f3de47d32901cfd4143aad653668 100644 --- a/ProcessLib/LiquidFlow/LiquidFlowLocalAssembler.h +++ b/ProcessLib/LiquidFlow/LiquidFlowLocalAssembler.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 19, 2016, 2:28 PM */ diff --git a/ProcessLib/LiquidFlow/LiquidFlowProcess.cpp b/ProcessLib/LiquidFlow/LiquidFlowProcess.cpp index 17308689cec96a13b35734aa5361815bcd58c26b..b63fdf00c4faf22ab350c8b7cf969889d4f7b9f7 100644 --- a/ProcessLib/LiquidFlow/LiquidFlowProcess.cpp +++ b/ProcessLib/LiquidFlow/LiquidFlowProcess.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 19, 2016, 1:38 PM */ diff --git a/ProcessLib/LiquidFlow/LiquidFlowProcess.h b/ProcessLib/LiquidFlow/LiquidFlowProcess.h index a331f5740b842cfac256e14d4a61adb53f4de0d1..a5f301c17f1e9ae5333709370c78f8758e5b424a 100644 --- a/ProcessLib/LiquidFlow/LiquidFlowProcess.h +++ b/ProcessLib/LiquidFlow/LiquidFlowProcess.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on August 19, 2016, 1:38 PM */ diff --git a/ProcessLib/Output/OutputFormat.cpp b/ProcessLib/Output/OutputFormat.cpp index 233615e3a6fc1ee909bbf037d7ca2c1905e35aaa..7c54cda07f2bcb06b2795336635f7f94cd3bf6c0 100644 --- a/ProcessLib/Output/OutputFormat.cpp +++ b/ProcessLib/Output/OutputFormat.cpp @@ -26,8 +26,8 @@ namespace ProcessLib { /** * Get a reference to the PVDFile corresponding to the given filename - * @param mesh_name the name of the mesh the PVD file is searched for - * @return Reference to a PVDFile object + * \param mesh_name the name of the mesh the PVD file is searched for + * \return Reference to a PVDFile object */ MeshLib::IO::PVDFile& OutputVTKFormat::findOrCreatePVDFile( std::string const& mesh_name) const diff --git a/ProcessLib/PhaseField/PhaseFieldFEM-impl.h b/ProcessLib/PhaseField/PhaseFieldFEM-impl.h index bd8ee0f683c63eb04e00d951f9fb4c6bcd020441..bcb618cf957ed7e16058936e0b83d712ca3d39db 100644 --- a/ProcessLib/PhaseField/PhaseFieldFEM-impl.h +++ b/ProcessLib/PhaseField/PhaseFieldFEM-impl.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on January 8, 2018, 3:00 PM */ #pragma once diff --git a/ProcessLib/RichardsMechanics/RichardsMechanicsFEM-impl.h b/ProcessLib/RichardsMechanics/RichardsMechanicsFEM-impl.h index 8703bdb00217b248f86438b4054034f82d448e75..6bcdd9710f919dd3f1651defc006e61e2a421682 100644 --- a/ProcessLib/RichardsMechanics/RichardsMechanicsFEM-impl.h +++ b/ProcessLib/RichardsMechanics/RichardsMechanicsFEM-impl.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on November 29, 2017, 2:03 PM */ diff --git a/ProcessLib/ThermoMechanicalPhaseField/ThermoMechanicalPhaseFieldFEM-impl.h b/ProcessLib/ThermoMechanicalPhaseField/ThermoMechanicalPhaseFieldFEM-impl.h index c4f202551f56d526462d11ab156b7a7d0f44be6b..a88630fc220ca751e8f8c5fd3a1d5ccb6aabda95 100644 --- a/ProcessLib/ThermoMechanicalPhaseField/ThermoMechanicalPhaseFieldFEM-impl.h +++ b/ProcessLib/ThermoMechanicalPhaseField/ThermoMechanicalPhaseFieldFEM-impl.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on January 8, 2018, 3:00 PM */ #pragma once diff --git a/ProcessLib/ThermoMechanics/ThermoMechanicsFEM-impl.h b/ProcessLib/ThermoMechanics/ThermoMechanicsFEM-impl.h index 01e3a9edfca0b50d554a3230cd0003b3e8f77065..4063e154731fb01da63f61ad3e3bfcd4892d842f 100644 --- a/ProcessLib/ThermoMechanics/ThermoMechanicsFEM-impl.h +++ b/ProcessLib/ThermoMechanics/ThermoMechanicsFEM-impl.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on July 2, 2019, 2:12 PM */ diff --git a/ProcessLib/ThermoRichardsMechanics/ThermoRichardsMechanicsFEM-impl.h b/ProcessLib/ThermoRichardsMechanics/ThermoRichardsMechanicsFEM-impl.h index 43c1b899258b119817b77761a20c5bcabd93dc63..63922804232a38762a818fcfc431cd0876cb20f7 100644 --- a/ProcessLib/ThermoRichardsMechanics/ThermoRichardsMechanicsFEM-impl.h +++ b/ProcessLib/ThermoRichardsMechanics/ThermoRichardsMechanicsFEM-impl.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on November 29, 2017, 2:03 PM */ diff --git a/Tests/BaseLib/TestConfigTree.cpp b/Tests/BaseLib/TestConfigTree.cpp index 1990ea7745623cae05e4b771e2d130a462bec7d2..1fa4a84cc51e451deac536991a0bd685beadc1a3 100644 --- a/Tests/BaseLib/TestConfigTree.cpp +++ b/Tests/BaseLib/TestConfigTree.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/BaseLib/TestFilePathStringManipulation.cpp b/Tests/BaseLib/TestFilePathStringManipulation.cpp index e3fe2d62012111e778a7c98d1523131ad666d026..71cf1e492e46ebe201131314ec8fb16ce3f325b7 100644 --- a/Tests/BaseLib/TestFilePathStringManipulation.cpp +++ b/Tests/BaseLib/TestFilePathStringManipulation.cpp @@ -1,8 +1,5 @@ /** * \file - * \author - * \date - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/line_source_term_x=5.prj b/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/line_source_term_x=5.prj deleted file mode 100644 index f72934d5a3b947a7d67bb4cf110b646c84c1d5d1..0000000000000000000000000000000000000000 --- a/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/line_source_term_x=5.prj +++ /dev/null @@ -1,142 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<OpenGeoSysProject> - <meshes> - <mesh>mesh_10x3_quad_10x3.vtu</mesh> - <mesh>line_x=5.vtu</mesh> - <mesh>mesh_10x3_right.vtu</mesh> - </meshes> - <processes> - <process> - <name>HeatConduction</name> - <type>HEAT_CONDUCTION</type> - <integration_order>2</integration_order> - <process_variables> - <process_variable>temperature</process_variable> - </process_variables> - <secondary_variables> - <secondary_variable internal_name="heat_flux" output_name="heat_flux"/> - </secondary_variables> - </process> - </processes> - <time_loop> - <processes> - <process ref="HeatConduction"> - <nonlinear_solver>basic_picard</nonlinear_solver> - <convergence_criterion> - <type>DeltaX</type> - <norm_type>NORM2</norm_type> - <abstol>1.e-6</abstol> - </convergence_criterion> - <time_discretization> - <type>BackwardEuler</type> - </time_discretization> - <time_stepping> - <type>FixedTimeStepping</type> - <t_initial> 0.0 </t_initial> - <t_end> 1 </t_end> - <timesteps> - <pair> - <repeat>1</repeat> - <delta_t>1</delta_t> - </pair> - </timesteps> - </time_stepping> - </process> - </processes> - <output> - <type>VTK</type> - <prefix>source_term_middle</prefix> - <timesteps> - <pair> - <repeat> 10000 </repeat> - <each_steps> 1 </each_steps> - </pair> - </timesteps> - <variables> - <variable> temperature </variable> - <variable> heat_flux </variable> - </variables> - <suffix>_ts_{:timestep}_t_{:time}</suffix> - </output> - </time_loop> - <media> - <medium id="0"> - <phases/> - <properties> - <property> - <name>specific_heat_capacity</name> - <type>Constant</type> - <value>1</value> - </property> - <property> - <name>thermal_conductivity</name> - <type>Constant</type> - <value>1</value> - </property> - <property> - <name>density</name> - <type>Constant</type> - <value>1</value> - </property> - </properties> - </medium> - </media> - <parameters> - <parameter> - <name>T0</name> - <type>Constant</type> - <value>0</value> - </parameter> - <parameter> - <name>HeatSource</name> - <type>Constant</type> - <value>1</value> - </parameter> - </parameters> - <process_variables> - <process_variable> - <name>temperature</name> - <components>1</components> - <order>1</order> - <initial_condition>T0</initial_condition> - <boundary_conditions> - <boundary_condition> - <mesh>mesh_10x3_right</mesh> - <type>Dirichlet</type> - <parameter>T0</parameter> - </boundary_condition> - </boundary_conditions> - <source_terms> - <source_term> - <mesh>line_x=5</mesh> - <type>Line</type> - <parameter>HeatSource</parameter> - </source_term> - </source_terms> - </process_variable> - </process_variables> - <nonlinear_solvers> - <nonlinear_solver> - <name>basic_picard</name> - <type>Picard</type> - <max_iter>10</max_iter> - <linear_solver>general_linear_solver</linear_solver> - </nonlinear_solver> - </nonlinear_solvers> - <linear_solvers> - <linear_solver> - <name>general_linear_solver</name> - <lis>-i cg -p jacobi -tol 1e-16 -maxiter 10000</lis> - <eigen> - <solver_type>CG</solver_type> - <precon_type>DIAGONAL</precon_type> - <max_iteration_step>10000</max_iteration_step> - <error_tolerance>1e-16</error_tolerance> - </eigen> - <petsc> - <prefix>gw</prefix> - <parameters>-gw_ksp_type cg -gw_pc_type bjacobi -gw_ksp_rtol 1e-16 -gw_ksp_max_it 10000</parameters> - </petsc> - </linear_solver> - </linear_solvers> -</OpenGeoSysProject> diff --git a/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/line_x=5.vtu b/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/line_x=5.vtu deleted file mode 100644 index dd404488773f939c2ab3a75e13490bc5bb507cbb..0000000000000000000000000000000000000000 --- a/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/line_x=5.vtu +++ /dev/null @@ -1,27 +0,0 @@ -<?xml version="1.0"?> -<VTKFile type="UnstructuredGrid" version="0.1" byte_order="LittleEndian" header_type="UInt32"> - <UnstructuredGrid> - <FieldData> - <DataArray type="UInt64" Name="bulk_element_ids" NumberOfTuples="6" format="appended" RangeMin="4" RangeMax="25" offset="0" /> - </FieldData> - <Piece NumberOfPoints="4" NumberOfCells="3" > - <PointData> - <DataArray type="UInt64" Name="bulk_node_ids" format="appended" RangeMin="5" RangeMax="38" offset="72" /> - </PointData> - <CellData> - <DataArray type="UInt64" Name="number_bulk_elements" format="appended" RangeMin="2" RangeMax="2" offset="120" /> - </CellData> - <Points> - <DataArray type="Float64" Name="Points" NumberOfComponents="3" format="appended" RangeMin="5" RangeMax="5.8309518948" offset="160" /> - </Points> - <Cells> - <DataArray type="Int64" Name="connectivity" format="appended" RangeMin="" RangeMax="" offset="296" /> - <DataArray type="Int64" Name="offsets" format="appended" RangeMin="" RangeMax="" offset="368" /> - <DataArray type="UInt8" Name="types" format="appended" RangeMin="" RangeMax="" offset="408" /> - </Cells> - </Piece> - </UnstructuredGrid> - <AppendedData encoding="base64"> - _MAAAAAQAAAAAAAAABQAAAAAAAAAOAAAAAAAAAA8AAAAAAAAAGAAAAAAAAAAZAAAAAAAAAA==IAAAAAUAAAAAAAAAEAAAAAAAAAAbAAAAAAAAACYAAAAAAAAAGAAAAAIAAAAAAAAAAgAAAAAAAAACAAAAAAAAAA==YAAAAAAAAAAAABRAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABRAAAAAAAAA8D8AAAAAAAAAAAAAAAAAABRAAAAAAAAAAEAAAAAAAAAAAAAAAAAAABRAAAAAAAAACEAAAAAAAAAAAA==MAAAAAAAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAIAAAAAAAAAAgAAAAAAAAADAAAAAAAAAA==GAAAAAIAAAAAAAAABAAAAAAAAAAGAAAAAAAAAA==AwAAAAMDAw== - </AppendedData> -</VTKFile> diff --git a/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/mesh_10x3_quad_10x3.vtu b/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/mesh_10x3_quad_10x3.vtu deleted file mode 100644 index ea2ff3be2b25fdd4f865c21148adf225008aaa7c..0000000000000000000000000000000000000000 --- a/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/mesh_10x3_quad_10x3.vtu +++ /dev/null @@ -1,22 +0,0 @@ -<?xml version="1.0"?> -<VTKFile type="UnstructuredGrid" version="0.1" byte_order="LittleEndian" header_type="UInt32"> - <UnstructuredGrid> - <Piece NumberOfPoints="44" NumberOfCells="30" > - <PointData> - </PointData> - <CellData> - </CellData> - <Points> - <DataArray type="Float64" Name="Points" NumberOfComponents="3" format="appended" RangeMin="0" RangeMax="10.440306509" offset="0" /> - </Points> - <Cells> - <DataArray type="Int64" Name="connectivity" format="appended" RangeMin="" RangeMax="" offset="1416" /> - <DataArray type="Int64" Name="offsets" format="appended" RangeMin="" RangeMax="" offset="2704" /> - <DataArray type="UInt8" Name="types" format="appended" RangeMin="" RangeMax="" offset="3032" /> - </Cells> - </Piece> - </UnstructuredGrid> - <AppendedData encoding="base64"> - _IAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAPA/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAhAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABRAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABhAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABxAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACJAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACRAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8AAAAAAAAAAAAAAAAAAPA/AAAAAAAA8D8AAAAAAAAAAAAAAAAAAABAAAAAAAAA8D8AAAAAAAAAAAAAAAAAAAhAAAAAAAAA8D8AAAAAAAAAAAAAAAAAABBAAAAAAAAA8D8AAAAAAAAAAAAAAAAAABRAAAAAAAAA8D8AAAAAAAAAAAAAAAAAABhAAAAAAAAA8D8AAAAAAAAAAAAAAAAAABxAAAAAAAAA8D8AAAAAAAAAAAAAAAAAACBAAAAAAAAA8D8AAAAAAAAAAAAAAAAAACJAAAAAAAAA8D8AAAAAAAAAAAAAAAAAACRAAAAAAAAA8D8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAPA/AAAAAAAAAEAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAhAAAAAAAAAAEAAAAAAAAAAAAAAAAAAABBAAAAAAAAAAEAAAAAAAAAAAAAAAAAAABRAAAAAAAAAAEAAAAAAAAAAAAAAAAAAABhAAAAAAAAAAEAAAAAAAAAAAAAAAAAAABxAAAAAAAAAAEAAAAAAAAAAAAAAAAAAACBAAAAAAAAAAEAAAAAAAAAAAAAAAAAAACJAAAAAAAAAAEAAAAAAAAAAAAAAAAAAACRAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACEAAAAAAAAAAAAAAAAAAAPA/AAAAAAAACEAAAAAAAAAAAAAAAAAAAABAAAAAAAAACEAAAAAAAAAAAAAAAAAAAAhAAAAAAAAACEAAAAAAAAAAAAAAAAAAABBAAAAAAAAACEAAAAAAAAAAAAAAAAAAABRAAAAAAAAACEAAAAAAAAAAAAAAAAAAABhAAAAAAAAACEAAAAAAAAAAAAAAAAAAABxAAAAAAAAACEAAAAAAAAAAAAAAAAAAACBAAAAAAAAACEAAAAAAAAAAAAAAAAAAACJAAAAAAAAACEAAAAAAAAAAAAAAAAAAACRAAAAAAAAACEAAAAAAAAAAAA==wAMAAAAAAAAAAAAAAQAAAAAAAAAMAAAAAAAAAAsAAAAAAAAAAQAAAAAAAAACAAAAAAAAAA0AAAAAAAAADAAAAAAAAAACAAAAAAAAAAMAAAAAAAAADgAAAAAAAAANAAAAAAAAAAMAAAAAAAAABAAAAAAAAAAPAAAAAAAAAA4AAAAAAAAABAAAAAAAAAAFAAAAAAAAABAAAAAAAAAADwAAAAAAAAAFAAAAAAAAAAYAAAAAAAAAEQAAAAAAAAAQAAAAAAAAAAYAAAAAAAAABwAAAAAAAAASAAAAAAAAABEAAAAAAAAABwAAAAAAAAAIAAAAAAAAABMAAAAAAAAAEgAAAAAAAAAIAAAAAAAAAAkAAAAAAAAAFAAAAAAAAAATAAAAAAAAAAkAAAAAAAAACgAAAAAAAAAVAAAAAAAAABQAAAAAAAAACwAAAAAAAAAMAAAAAAAAABcAAAAAAAAAFgAAAAAAAAAMAAAAAAAAAA0AAAAAAAAAGAAAAAAAAAAXAAAAAAAAAA0AAAAAAAAADgAAAAAAAAAZAAAAAAAAABgAAAAAAAAADgAAAAAAAAAPAAAAAAAAABoAAAAAAAAAGQAAAAAAAAAPAAAAAAAAABAAAAAAAAAAGwAAAAAAAAAaAAAAAAAAABAAAAAAAAAAEQAAAAAAAAAcAAAAAAAAABsAAAAAAAAAEQAAAAAAAAASAAAAAAAAAB0AAAAAAAAAHAAAAAAAAAASAAAAAAAAABMAAAAAAAAAHgAAAAAAAAAdAAAAAAAAABMAAAAAAAAAFAAAAAAAAAAfAAAAAAAAAB4AAAAAAAAAFAAAAAAAAAAVAAAAAAAAACAAAAAAAAAAHwAAAAAAAAAWAAAAAAAAABcAAAAAAAAAIgAAAAAAAAAhAAAAAAAAABcAAAAAAAAAGAAAAAAAAAAjAAAAAAAAACIAAAAAAAAAGAAAAAAAAAAZAAAAAAAAACQAAAAAAAAAIwAAAAAAAAAZAAAAAAAAABoAAAAAAAAAJQAAAAAAAAAkAAAAAAAAABoAAAAAAAAAGwAAAAAAAAAmAAAAAAAAACUAAAAAAAAAGwAAAAAAAAAcAAAAAAAAACcAAAAAAAAAJgAAAAAAAAAcAAAAAAAAAB0AAAAAAAAAKAAAAAAAAAAnAAAAAAAAAB0AAAAAAAAAHgAAAAAAAAApAAAAAAAAACgAAAAAAAAAHgAAAAAAAAAfAAAAAAAAACoAAAAAAAAAKQAAAAAAAAAfAAAAAAAAACAAAAAAAAAAKwAAAAAAAAAqAAAAAAAAAA==8AAAAAQAAAAAAAAACAAAAAAAAAAMAAAAAAAAABAAAAAAAAAAFAAAAAAAAAAYAAAAAAAAABwAAAAAAAAAIAAAAAAAAAAkAAAAAAAAACgAAAAAAAAALAAAAAAAAAAwAAAAAAAAADQAAAAAAAAAOAAAAAAAAAA8AAAAAAAAAEAAAAAAAAAARAAAAAAAAABIAAAAAAAAAEwAAAAAAAAAUAAAAAAAAABUAAAAAAAAAFgAAAAAAAAAXAAAAAAAAABgAAAAAAAAAGQAAAAAAAAAaAAAAAAAAABsAAAAAAAAAHAAAAAAAAAAdAAAAAAAAAB4AAAAAAAAAA==HgAAAAkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQ== - </AppendedData> -</VTKFile> diff --git a/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/mesh_10x3_right.vtu b/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/mesh_10x3_right.vtu deleted file mode 100644 index aa3c1ebe905da4d5db701feeb6b85e2d57c46e18..0000000000000000000000000000000000000000 --- a/Tests/Data/Parabolic/T/2D_source_term_tests/line_source_term_x_5/mesh_10x3_right.vtu +++ /dev/null @@ -1,24 +0,0 @@ -<?xml version="1.0"?> -<VTKFile type="UnstructuredGrid" version="0.1" byte_order="LittleEndian" header_type="UInt32"> - <UnstructuredGrid> - <Piece NumberOfPoints="2" NumberOfCells="1" > - <PointData> - <DataArray type="UInt64" Name="bulk_node_ids" format="appended" RangeMin="10" RangeMax="21" offset="0" /> - </PointData> - <CellData> - <DataArray type="UInt64" Name="bulk_element_ids" format="appended" RangeMin="9" RangeMax="9" offset="28" /> - </CellData> - <Points> - <DataArray type="Float64" Name="Points" NumberOfComponents="3" format="appended" RangeMin="10" RangeMax="10.049875621" offset="44" /> - </Points> - <Cells> - <DataArray type="Int64" Name="connectivity" format="appended" RangeMin="" RangeMax="" offset="116" /> - <DataArray type="Int64" Name="offsets" format="appended" RangeMin="" RangeMax="" offset="144" /> - <DataArray type="UInt8" Name="types" format="appended" RangeMin="" RangeMax="" offset="160" /> - </Cells> - </Piece> - </UnstructuredGrid> - <AppendedData encoding="base64"> - _EAAAABUAAAAAAAAACgAAAAAAAAA=CAAAAAkAAAAAAAAAMAAAAAAAAAAAACRAAAAAAAAA8D8AAAAAAAAAAAAAAAAAACRAAAAAAAAAAAAAAAAAAAAAAA==EAAAAAEAAAAAAAAAAAAAAAAAAAA=CAAAAAIAAAAAAAAAAQAAAAM= - </AppendedData> -</VTKFile> diff --git a/Tests/FileIO/TestCsvWriter.cpp b/Tests/FileIO/TestCsvWriter.cpp index 3d8b60413ecfc42c6398da224b2d1bf8a44e283d..aea56105973286db9a060f4e93416477a754b2ce 100644 --- a/Tests/FileIO/TestCsvWriter.cpp +++ b/Tests/FileIO/TestCsvWriter.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/FileIO/TestGmsInterface.cpp b/Tests/FileIO/TestGmsInterface.cpp index 1ba880e110b919890a15a340f8f19bb1f06a0421..5d20fad875bf322daa384a64326ae1fc82d1baee 100644 --- a/Tests/FileIO/TestGmsInterface.cpp +++ b/Tests/FileIO/TestGmsInterface.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/FileIO_Qt/TestFEFLOWInterface.cpp b/Tests/FileIO_Qt/TestFEFLOWInterface.cpp index dfea520e2b39c314a1fe4a17d6833ef4b476c6a3..01c050a103fa7e44b6520172110c3cd4a28772f8 100644 --- a/Tests/FileIO_Qt/TestFEFLOWInterface.cpp +++ b/Tests/FileIO_Qt/TestFEFLOWInterface.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/FileIO_Qt/TestQtPrjInterface.cpp b/Tests/FileIO_Qt/TestQtPrjInterface.cpp index 8aab614366cd869b57345ef628b402495c3cee0f..30046c74da3350f510fe64325a8e4999528385d9 100644 --- a/Tests/FileIO_Qt/TestQtPrjInterface.cpp +++ b/Tests/FileIO_Qt/TestQtPrjInterface.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/FileIO_Qt/TestVtkRaster.cpp b/Tests/FileIO_Qt/TestVtkRaster.cpp index 329cab0ae20056a340c51e7d07b1d965d9b4bdb2..ddc107a8fca8f6e2a8ad8adcb705005b34ceb459 100644 --- a/Tests/FileIO_Qt/TestVtkRaster.cpp +++ b/Tests/FileIO_Qt/TestVtkRaster.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/GeoLib/IO/TestGLIReader.cpp b/Tests/GeoLib/IO/TestGLIReader.cpp index 51d38eb7ed18d0a677be8e3831dc11734ae9ad6e..18781c26c746a0b1b30becb1c2fa5c8e79d408e0 100644 --- a/Tests/GeoLib/IO/TestGLIReader.cpp +++ b/Tests/GeoLib/IO/TestGLIReader.cpp @@ -1,4 +1,5 @@ /** + * \file * \date 2014-10-14 * * \copyright diff --git a/Tests/GeoLib/TestComputeAndInsertAllIntersectionPoints.cpp b/Tests/GeoLib/TestComputeAndInsertAllIntersectionPoints.cpp index 541a1ef064a8ba5ae053a4076f466748f2bc58bb..17d64ca7281a2578606d912635964532e4982e7d 100644 --- a/Tests/GeoLib/TestComputeAndInsertAllIntersectionPoints.cpp +++ b/Tests/GeoLib/TestComputeAndInsertAllIntersectionPoints.cpp @@ -1,6 +1,6 @@ /** - * @file TestComputeAndInsertAllIntersectionPoints.cpp - * @date 2014-05-09 + * \file + * \date 2014-05-09 * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/GeoLib/TestComputeRotationMatrix.cpp b/Tests/GeoLib/TestComputeRotationMatrix.cpp index 51f890ae707a18198d0cca74f41c5adb04e8b685..646afa738edc6da664afdc03f9e7c38bab6d0a42 100644 --- a/Tests/GeoLib/TestComputeRotationMatrix.cpp +++ b/Tests/GeoLib/TestComputeRotationMatrix.cpp @@ -1,6 +1,6 @@ /** - * @file TestComputeRotationMatrix.cpp - * @date 2015-04-23 + * \file + * \date 2015-04-23 * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/GeoLib/TestDuplicateGeometry.cpp b/Tests/GeoLib/TestDuplicateGeometry.cpp index 9388bf3f16b456e1b761cce8b0847bb84673a94f..e7e2cf8645a14965164370f9a9891116aa648ba2 100644 --- a/Tests/GeoLib/TestDuplicateGeometry.cpp +++ b/Tests/GeoLib/TestDuplicateGeometry.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/GeoLib/TestParallel.cpp b/Tests/GeoLib/TestParallel.cpp index b9447f85382656ce8eb2697eac852a8b4042b02b..62a68d7da8ca5dcbc6003f3290ad0858f0c93358 100644 --- a/Tests/GeoLib/TestParallel.cpp +++ b/Tests/GeoLib/TestParallel.cpp @@ -1,6 +1,6 @@ /** - * @file TestParall.cpp - * @date Feb 26, 2014 + * \file + * \date Feb 26, 2014 * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/GeoLib/TestSimplePolygonTree.cpp b/Tests/GeoLib/TestSimplePolygonTree.cpp index c386f4439598350082a4b42d1b4af1dd56fdbcf4..589309367bcf36e021c48a9b62b1d09cff0dcbae 100644 --- a/Tests/GeoLib/TestSimplePolygonTree.cpp +++ b/Tests/GeoLib/TestSimplePolygonTree.cpp @@ -1,8 +1,7 @@ /** - * @file TestSimplePolygonTree.cpp - * @author - * @date Apr 02, 2014 - * @brief Test functionality of class SimplePolygonTree. + * \file + * \date Apr 02, 2014 + * \brief Test functionality of class SimplePolygonTree. * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/GeoLib/TestSortSegments.cpp b/Tests/GeoLib/TestSortSegments.cpp index c235d432d7c03c66e0fffa0cdfc2ad6ba2a6dfda..3670709b82bfb5d5441f07e39d3a963e4a1be73a 100644 --- a/Tests/GeoLib/TestSortSegments.cpp +++ b/Tests/GeoLib/TestSortSegments.cpp @@ -1,4 +1,5 @@ /** + * \file * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/MaterialLib/TestCapillaryPressureSaturationModel.cpp b/Tests/MaterialLib/TestCapillaryPressureSaturationModel.cpp index c0c8e3a87b23fda87a18fe5054171d77735cdf99..fbdad462eeff91a7fb17cf2d437353e54a8814bf 100644 --- a/Tests/MaterialLib/TestCapillaryPressureSaturationModel.cpp +++ b/Tests/MaterialLib/TestCapillaryPressureSaturationModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 1, 2016, 11:06 AM */ diff --git a/Tests/MaterialLib/TestDimensionLessGibbsFreeEnergy.cpp b/Tests/MaterialLib/TestDimensionLessGibbsFreeEnergy.cpp index 11bcbd541e9b509dbfe4d67e54dd6df390c7a30d..59c7e019a62dfb4cc81aa62f7635f66a01ea18b7 100644 --- a/Tests/MaterialLib/TestDimensionLessGibbsFreeEnergy.cpp +++ b/Tests/MaterialLib/TestDimensionLessGibbsFreeEnergy.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on December 9, 2016, 12:31 PM */ diff --git a/Tests/MaterialLib/TestFluidProperties.cpp b/Tests/MaterialLib/TestFluidProperties.cpp index a8f9c03f9a5e8b4cb4db75093d9bd8d871887e2a..bf3bfbe9b8f0f63f0575dbd2b8335a28b1790182 100644 --- a/Tests/MaterialLib/TestFluidProperties.cpp +++ b/Tests/MaterialLib/TestFluidProperties.cpp @@ -1,4 +1,5 @@ /** + * \file * \brief Test the creator of FluidProperties * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * */ diff --git a/Tests/MaterialLib/TestFluidSpecificHeatCapacityModel.cpp b/Tests/MaterialLib/TestFluidSpecificHeatCapacityModel.cpp index cf739ce616f64af937b94c98e5723f58ab4b1f1e..4ca2620e65f4878032a2183193642646ebf5f362 100644 --- a/Tests/MaterialLib/TestFluidSpecificHeatCapacityModel.cpp +++ b/Tests/MaterialLib/TestFluidSpecificHeatCapacityModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * */ diff --git a/Tests/MaterialLib/TestFluidThermalConductivityModel.cpp b/Tests/MaterialLib/TestFluidThermalConductivityModel.cpp index 8e99fce61e34fe4f3127aa36d41cb212e4bab6b5..91822756b1a0b7291fe36132e9971c3ccb3a6959 100644 --- a/Tests/MaterialLib/TestFluidThermalConductivityModel.cpp +++ b/Tests/MaterialLib/TestFluidThermalConductivityModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * */ diff --git a/Tests/MaterialLib/TestFluidViscosity.cpp b/Tests/MaterialLib/TestFluidViscosity.cpp index dc4c394c0088b6bf8185fe4a8ae09759d588c85a..9960103d5863d0dc7fae9d4b09ec61be7e626f47 100644 --- a/Tests/MaterialLib/TestFluidViscosity.cpp +++ b/Tests/MaterialLib/TestFluidViscosity.cpp @@ -1,4 +1,5 @@ /** + * \file * \brief Test viscosity models * * \copyright @@ -7,7 +8,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * */ diff --git a/Tests/MaterialLib/TestMPL.cpp b/Tests/MaterialLib/TestMPL.cpp index d74857a50935b1ba4aa589519d23cd042d769ecd..025dfccc2f914a6199ac2e360da70dd9dbc8a2eb 100644 --- a/Tests/MaterialLib/TestMPL.cpp +++ b/Tests/MaterialLib/TestMPL.cpp @@ -2,7 +2,6 @@ * \file * \author Norbert Grunwald * \date Oct 22, 2018 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/MaterialLib/TestMPLPermeabilityVermaPruessModel.cpp b/Tests/MaterialLib/TestMPLPermeabilityVermaPruessModel.cpp index fc856a3263eb5ba3ffc492b40009e30c1f6758cc..dcf28f6f9200d3b5860ef7c2bb1a59341123ae47 100644 --- a/Tests/MaterialLib/TestMPLPermeabilityVermaPruessModel.cpp +++ b/Tests/MaterialLib/TestMPLPermeabilityVermaPruessModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 3:09 PM */ diff --git a/Tests/MaterialLib/TestRelativePermeabilityModel.cpp b/Tests/MaterialLib/TestRelativePermeabilityModel.cpp index dc5eb33ad81908fc522487a1f03fb9d4948df225..71c9a23caf3f1fe3ea39a4b381a226d6a208cd87 100644 --- a/Tests/MaterialLib/TestRelativePermeabilityModel.cpp +++ b/Tests/MaterialLib/TestRelativePermeabilityModel.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 2, 2016, 3:09 PM */ diff --git a/Tests/MathLib/SimpleTestsPoint3d.cpp b/Tests/MathLib/SimpleTestsPoint3d.cpp index 41258a555a49fa1f10d058c38f4815878ef04f50..802d7d74a16f8a812784b5f72ae2db75af5e528c 100644 --- a/Tests/MathLib/SimpleTestsPoint3d.cpp +++ b/Tests/MathLib/SimpleTestsPoint3d.cpp @@ -1,6 +1,6 @@ /** - * @file TestPoint3d.cpp - * @date Mar 13, 2014 + * \file + * \date Mar 13, 2014 * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/MathLib/TestEigenCSR.cpp b/Tests/MathLib/TestEigenCSR.cpp index 0307ff2d658e890f5ff0f096393ff17f3dca2e04..9b49abee35aaefc57f5f78e03b9bd8cc518ca627 100644 --- a/Tests/MathLib/TestEigenCSR.cpp +++ b/Tests/MathLib/TestEigenCSR.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/MathLib/TestIsPointInTriangle.cpp b/Tests/MathLib/TestIsPointInTriangle.cpp index 585246203f99412844d76e11d3c32b36475a6778..5d92e73362c59e0a9cfd78bb239f7aaaaf1bf588 100644 --- a/Tests/MathLib/TestIsPointInTriangle.cpp +++ b/Tests/MathLib/TestIsPointInTriangle.cpp @@ -1,6 +1,6 @@ /** - * @file TestIsPointInTriangle.cpp - * @date 2014-05-27 + * \file + * \date 2014-05-27 * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/MathLib/TestNonlinear1D.cpp b/Tests/MathLib/TestNonlinear1D.cpp index 885758ff97e935c02fd6e92d97865c76a33ce4c4..e82e76d3b6959814cb25e2049dee551452f52bbf 100644 --- a/Tests/MathLib/TestNonlinear1D.cpp +++ b/Tests/MathLib/TestNonlinear1D.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/MathLib/TestODESolver.cpp b/Tests/MathLib/TestODESolver.cpp index c6605de8091938e0e3d52bf60567687eebec13ef..4e429c56c638f3120fc5cd88ba01d2ef3adee370 100644 --- a/Tests/MathLib/TestODESolver.cpp +++ b/Tests/MathLib/TestODESolver.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/MathLib/TestPiecewiseLinearCurve.cpp b/Tests/MathLib/TestPiecewiseLinearCurve.cpp index fd432e4fd7959c44126445f50c9ec3b7ec91f613..d33baff271853e9d65f57607dbd0e6aa702ebe31 100644 --- a/Tests/MathLib/TestPiecewiseLinearCurve.cpp +++ b/Tests/MathLib/TestPiecewiseLinearCurve.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * * Created on November 11, 2016, 10:58 AM */ diff --git a/Tests/MeshGeoToolsLib/TestEarClipping.cpp b/Tests/MeshGeoToolsLib/TestEarClipping.cpp index 84473dc113bd4fd667447f9fbfccb9ce6464110e..8a61514385b566d48f66a7e33de771984b42c04e 100644 --- a/Tests/MeshGeoToolsLib/TestEarClipping.cpp +++ b/Tests/MeshGeoToolsLib/TestEarClipping.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/MeshLib/TestMoveMeshNodes.cpp b/Tests/MeshLib/TestMoveMeshNodes.cpp index 3fe08f9f8c35e23c6ed2965589a711876f1d800f..807c50583d6dcedb70658b3d190652952e1294a4 100644 --- a/Tests/MeshLib/TestMoveMeshNodes.cpp +++ b/Tests/MeshLib/TestMoveMeshNodes.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/MeshLib/TestNodeAdjacencyTable.cpp b/Tests/MeshLib/TestNodeAdjacencyTable.cpp index 17145b61a0c5810a030563aa4b272d531a86dd25..893ff6bbadf9cf88b89f88161393797af1887894 100644 --- a/Tests/MeshLib/TestNodeAdjacencyTable.cpp +++ b/Tests/MeshLib/TestNodeAdjacencyTable.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/MeshLib/TestRasterToMesh.cpp b/Tests/MeshLib/TestRasterToMesh.cpp index 0a2c80ed3c6958a07fcdc734042328344b6bd35c..8f84cd22f9eacd9c68d5d15b85b29f478bb38e0a 100644 --- a/Tests/MeshLib/TestRasterToMesh.cpp +++ b/Tests/MeshLib/TestRasterToMesh.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/MatrixTools.h b/Tests/NumLib/FeTestData/MatrixTools.h index b15cfa7e5f59706d690e2b83ae65fecae15b75ea..96aebc78ce57de675a1060bbda04ef7fd3b27e3d 100644 --- a/Tests/NumLib/FeTestData/MatrixTools.h +++ b/Tests/NumLib/FeTestData/MatrixTools.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFeHEX20.h b/Tests/NumLib/FeTestData/TestFeHEX20.h index eed2db95513bcd0a0f9ee0b3837b9e637a28a2ef..3a8f600d42c97751513b468cd3f33f1d2bac00c1 100644 --- a/Tests/NumLib/FeTestData/TestFeHEX20.h +++ b/Tests/NumLib/FeTestData/TestFeHEX20.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 13, 2017, 2:40 PM */ diff --git a/Tests/NumLib/FeTestData/TestFeHEX8.h b/Tests/NumLib/FeTestData/TestFeHEX8.h index 8296a0f2cdb6c50fcb7bc34c4dc65c687d0b98cd..7dd0a3c910a0d882a2f8a2b1b697b8af975636b7 100644 --- a/Tests/NumLib/FeTestData/TestFeHEX8.h +++ b/Tests/NumLib/FeTestData/TestFeHEX8.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFeLINE2.h b/Tests/NumLib/FeTestData/TestFeLINE2.h index fb79b04064bb2c8a04ed3ed178b282597a3c4b6b..11b900a8e849925888f6717574ee82c2842f4716 100644 --- a/Tests/NumLib/FeTestData/TestFeLINE2.h +++ b/Tests/NumLib/FeTestData/TestFeLINE2.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFeLINE2Y.h b/Tests/NumLib/FeTestData/TestFeLINE2Y.h index c92aa4875cb562de0e02cb719991b68ac57eb998..ce50f000e852ac0fe1d8dc8a6e9ea469d9890c16 100644 --- a/Tests/NumLib/FeTestData/TestFeLINE2Y.h +++ b/Tests/NumLib/FeTestData/TestFeLINE2Y.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFeLINE3.h b/Tests/NumLib/FeTestData/TestFeLINE3.h index 4f3960b1cbd9f70879e58189df33154d9bf93704..e0bf12c1afbd148628327fd6ae0c6dd8028fd41a 100644 --- a/Tests/NumLib/FeTestData/TestFeLINE3.h +++ b/Tests/NumLib/FeTestData/TestFeLINE3.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFePRISM15.h b/Tests/NumLib/FeTestData/TestFePRISM15.h index 34fde1b2ced8fff9d30eae8f7ba1b18d315f4425..559e69c09f2bcdd937bbcdaeae529e601e84076d 100644 --- a/Tests/NumLib/FeTestData/TestFePRISM15.h +++ b/Tests/NumLib/FeTestData/TestFePRISM15.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 13, 2017, 2:56 PM */ diff --git a/Tests/NumLib/FeTestData/TestFePRISM6.h b/Tests/NumLib/FeTestData/TestFePRISM6.h index c4ea556d787604fd5947abfa8348b15e768da84c..2225ade7996ab8be2e5299b0246765c5f4fae5a2 100644 --- a/Tests/NumLib/FeTestData/TestFePRISM6.h +++ b/Tests/NumLib/FeTestData/TestFePRISM6.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFePYRA13.h b/Tests/NumLib/FeTestData/TestFePYRA13.h index ab9dda433aadff46562d2f994debc0ff39525549..add66498e123271980eadec01e2f6e3b15a0611c 100644 --- a/Tests/NumLib/FeTestData/TestFePYRA13.h +++ b/Tests/NumLib/FeTestData/TestFePYRA13.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 13, 2017, 2:57 PM */ diff --git a/Tests/NumLib/FeTestData/TestFePYRA5.h b/Tests/NumLib/FeTestData/TestFePYRA5.h index 8584900664ee461c8c08ab38dd48497e0d9658a3..078f8368fec0c5c943faee4cbf8a30afbe4cb9c7 100644 --- a/Tests/NumLib/FeTestData/TestFePYRA5.h +++ b/Tests/NumLib/FeTestData/TestFePYRA5.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFeQUAD4.h b/Tests/NumLib/FeTestData/TestFeQUAD4.h index 435b60a6ff3c22717dd4a016608c0ed10deb1790..fc6b8bd52bcbc961b1bec3a8b2b4cd26964da0c7 100644 --- a/Tests/NumLib/FeTestData/TestFeQUAD4.h +++ b/Tests/NumLib/FeTestData/TestFeQUAD4.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFeQUAD8.h b/Tests/NumLib/FeTestData/TestFeQUAD8.h index b4027618aaf8edfb9d821287e3a652a266f6aef4..8341c0c47865b84b66acf6aa7dc631064a78c0fb 100644 --- a/Tests/NumLib/FeTestData/TestFeQUAD8.h +++ b/Tests/NumLib/FeTestData/TestFeQUAD8.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 13, 2017, 3:00 PM */ diff --git a/Tests/NumLib/FeTestData/TestFeQUAD9.h b/Tests/NumLib/FeTestData/TestFeQUAD9.h index c4115e18f978526ce4e16dc401784457e3affb00..0b659a7206461835e4582a9afbeec65da0a7a7c3 100644 --- a/Tests/NumLib/FeTestData/TestFeQUAD9.h +++ b/Tests/NumLib/FeTestData/TestFeQUAD9.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 13, 2017, 2:52 PM */ diff --git a/Tests/NumLib/FeTestData/TestFeTET10.h b/Tests/NumLib/FeTestData/TestFeTET10.h index 4b95aa5e1fc63b28e1dcf1a674acc5cadcbfaf3f..81a5a0a8814fd9be0dafcf9189e45619d35027f4 100644 --- a/Tests/NumLib/FeTestData/TestFeTET10.h +++ b/Tests/NumLib/FeTestData/TestFeTET10.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 13, 2017, 2:57 PM */ diff --git a/Tests/NumLib/FeTestData/TestFeTET4.h b/Tests/NumLib/FeTestData/TestFeTET4.h index 3ad3d252a59e3ad1b9feb3d9d7b411ea958f18a8..1c4a4448af6836d08079721530b556ab90124fd3 100644 --- a/Tests/NumLib/FeTestData/TestFeTET4.h +++ b/Tests/NumLib/FeTestData/TestFeTET4.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFeTRI3.h b/Tests/NumLib/FeTestData/TestFeTRI3.h index 6813e41110390da13faa5d3853100b0336cf7a3b..e795b2d85c337b57862d81f4be6064fc57e3373b 100644 --- a/Tests/NumLib/FeTestData/TestFeTRI3.h +++ b/Tests/NumLib/FeTestData/TestFeTRI3.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/FeTestData/TestFeTRI6.h b/Tests/NumLib/FeTestData/TestFeTRI6.h index 737ffea401d30586fda85a167d8fb610264a4666..f93aed36c1e8b0b38ca0bf054604226b89bf4c98 100644 --- a/Tests/NumLib/FeTestData/TestFeTRI6.h +++ b/Tests/NumLib/FeTestData/TestFeTRI6.h @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 13, 2017, 2:58 PM */ diff --git a/Tests/NumLib/LocalToGlobalIndexMap.cpp b/Tests/NumLib/LocalToGlobalIndexMap.cpp index 45dbc32bc1e114988ef1f7be34781594ca0467c3..c13203839f1cd97e2e6bf831f531fe14fd714f8a 100644 --- a/Tests/NumLib/LocalToGlobalIndexMap.cpp +++ b/Tests/NumLib/LocalToGlobalIndexMap.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/LocalToGlobalIndexMapMultiComponent.cpp b/Tests/NumLib/LocalToGlobalIndexMapMultiComponent.cpp index c2ec896d2e890e5b43dd84b36d23ef52ae0d5484..4049fecc475c75659bc0e1fea30295ed69e3aa02 100644 --- a/Tests/NumLib/LocalToGlobalIndexMapMultiComponent.cpp +++ b/Tests/NumLib/LocalToGlobalIndexMapMultiComponent.cpp @@ -1,4 +1,5 @@ /* + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/NaturalNodeCoordinates.cpp b/Tests/NumLib/NaturalNodeCoordinates.cpp index be6c61844ba2e6deebe53d61e4e8d4b901f1df8b..7c55d80262b10834c4e21541e87043412621b28a 100644 --- a/Tests/NumLib/NaturalNodeCoordinates.cpp +++ b/Tests/NumLib/NaturalNodeCoordinates.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/NewtonRaphson.cpp b/Tests/NumLib/NewtonRaphson.cpp index f31f117edede1917406f15f1f451d1d5acbf2f75..44613a08a4ff1376ea7e3e4f323ae5a4981e2bc8 100644 --- a/Tests/NumLib/NewtonRaphson.cpp +++ b/Tests/NumLib/NewtonRaphson.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/ODEs.h b/Tests/NumLib/ODEs.h index 15c98d5eb3aa6b71a8be4326312a1194b25ea900..7eee179e5f56c55d8bc3f49138f70b457d878705 100644 --- a/Tests/NumLib/ODEs.h +++ b/Tests/NumLib/ODEs.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/SteadyDiffusion2DExample1.h b/Tests/NumLib/SteadyDiffusion2DExample1.h index e424d53f2cee816341d7a40872bced42a2f9dbf9..97e3817977a11a69d57b2c55f9584ad56039606d 100644 --- a/Tests/NumLib/SteadyDiffusion2DExample1.h +++ b/Tests/NumLib/SteadyDiffusion2DExample1.h @@ -1,4 +1,5 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-04-18 * diff --git a/Tests/NumLib/TestComponentNorms.cpp b/Tests/NumLib/TestComponentNorms.cpp index 6c149a009708e48b9986082c34d44eeb2aaeab60..8bd46b751a3decc70a629378800bf0be8d2450c5 100644 --- a/Tests/NumLib/TestComponentNorms.cpp +++ b/Tests/NumLib/TestComponentNorms.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/TestExtrapolation.cpp b/Tests/NumLib/TestExtrapolation.cpp index 29048c321312001b903fe3cf8d5f8c9e59b73367..87a8ebf63b6f136ab0df313bd746c4a0a371847a 100644 --- a/Tests/NumLib/TestExtrapolation.cpp +++ b/Tests/NumLib/TestExtrapolation.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/TestFe.cpp b/Tests/NumLib/TestFe.cpp index 86878c96bbc0dbb82812d672efba197cb4b9926c..2f64371cc8fc4c6685736cadc816b972c0367e36 100644 --- a/Tests/NumLib/TestFe.cpp +++ b/Tests/NumLib/TestFe.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/TestGradShapeFunctionAndVolumeCalculation.cpp b/Tests/NumLib/TestGradShapeFunctionAndVolumeCalculation.cpp index 6f48f5e2e7ee9c542feefe28f591ca07f5fa4847..5a2d5830a0acd45a116d74ff3881b83f62ed176b 100644 --- a/Tests/NumLib/TestGradShapeFunctionAndVolumeCalculation.cpp +++ b/Tests/NumLib/TestGradShapeFunctionAndVolumeCalculation.cpp @@ -1,4 +1,5 @@ /** + * \file * \brief Test the gradient of shape functions via the numerical volume * integration. * @@ -8,7 +9,6 @@ * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on July 14, 2017, 10:08 AM */ diff --git a/Tests/NumLib/TestMeshComponentMap.cpp b/Tests/NumLib/TestMeshComponentMap.cpp index ab2d9f9d7940087950cb4114e2c2fa487f09c487..80f9aec247cb00b222364ff837e0ffd83ba0b0bb 100644 --- a/Tests/NumLib/TestMeshComponentMap.cpp +++ b/Tests/NumLib/TestMeshComponentMap.cpp @@ -1,4 +1,5 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-04-16 * diff --git a/Tests/NumLib/TestODEInt.cpp b/Tests/NumLib/TestODEInt.cpp index ea508c88b7832caec932a41056350169e18b7844..23b1b5f8ca0fd848a1c51c223c98bec0b3faa103 100644 --- a/Tests/NumLib/TestODEInt.cpp +++ b/Tests/NumLib/TestODEInt.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/TestSerialExecutor.cpp b/Tests/NumLib/TestSerialExecutor.cpp index 606371d0be3bcd8ad0d6ed99df241b1d0a605b2f..282367b1482a388b20bc5c4efd7aef036fbcecde 100644 --- a/Tests/NumLib/TestSerialExecutor.cpp +++ b/Tests/NumLib/TestSerialExecutor.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/TestSerialLinearSolver.cpp b/Tests/NumLib/TestSerialLinearSolver.cpp index 69d07e6c0a8b3b2433739fe48ce7a50fb9537d4e..7d235f5ef5f6b257a1469b23bef5a39a5693cd19 100644 --- a/Tests/NumLib/TestSerialLinearSolver.cpp +++ b/Tests/NumLib/TestSerialLinearSolver.cpp @@ -1,4 +1,5 @@ /** + * \file * \author Norihiro Watanabe * \date 2013-04-18 * diff --git a/Tests/NumLib/TestTimeStep.cpp b/Tests/NumLib/TestTimeStep.cpp index e5ed79a72bf2993a40ca114e4dfd1947b349758a..da35b9bdedf90ee12b112d1d446bc94fd12a29cf 100644 --- a/Tests/NumLib/TestTimeStep.cpp +++ b/Tests/NumLib/TestTimeStep.cpp @@ -1,4 +1,5 @@ /** + * \file * \author Norihiro Watanabe * \date 2012-08-03 * diff --git a/Tests/NumLib/TestTimeSteppingEvolutionaryPIDcontroller.cpp b/Tests/NumLib/TestTimeSteppingEvolutionaryPIDcontroller.cpp index 555f48b2639d47fe541911bc9e4c87a80f7af516..deac97076c985c36f86ce8242296121fc82338f4 100644 --- a/Tests/NumLib/TestTimeSteppingEvolutionaryPIDcontroller.cpp +++ b/Tests/NumLib/TestTimeSteppingEvolutionaryPIDcontroller.cpp @@ -1,11 +1,11 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. * See accompanying file LICENSE.txt or * http://www.opengeosys.org/project/license * - * \file * Created on April 5, 2017, 12:09 PM */ diff --git a/Tests/NumLib/TestTimeSteppingFixed.cpp b/Tests/NumLib/TestTimeSteppingFixed.cpp index d03e15ba5d9197a2f44b58d72ffb09b7e090057d..18d67fc806af3652e2df19e594ffc1c6e761a6d5 100644 --- a/Tests/NumLib/TestTimeSteppingFixed.cpp +++ b/Tests/NumLib/TestTimeSteppingFixed.cpp @@ -1,4 +1,5 @@ /** + * \file * \author Norihiro Watanabe * \date 2012-08-03 * diff --git a/Tests/NumLib/TestTimeSteppingIterationNumber.cpp b/Tests/NumLib/TestTimeSteppingIterationNumber.cpp index 429dc28474c03a884716c0db0faf6f3ff4aa4b82..e7681be237abb30efe9bc0cebb35c51af64f4e87 100644 --- a/Tests/NumLib/TestTimeSteppingIterationNumber.cpp +++ b/Tests/NumLib/TestTimeSteppingIterationNumber.cpp @@ -1,4 +1,5 @@ /** + * \file * \author Norihiro Watanabe * \date 2012-08-03 * diff --git a/Tests/NumLib/TimeLoopSingleODE.h b/Tests/NumLib/TimeLoopSingleODE.h index 0d08494b077e2ce9cbe31c1c8b62edc804262252..94b3dd535ccdc8dc8f31e8abeffa8f50d6f501f7 100644 --- a/Tests/NumLib/TimeLoopSingleODE.h +++ b/Tests/NumLib/TimeLoopSingleODE.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/NumLib/TimeSteppingTestingTools.h b/Tests/NumLib/TimeSteppingTestingTools.h index 83a2be181205ecf549226ba6200b672c99dbcb7e..4c6de49565d4be689aa85db24871e1f25730b73e 100644 --- a/Tests/NumLib/TimeSteppingTestingTools.h +++ b/Tests/NumLib/TimeSteppingTestingTools.h @@ -1,4 +1,5 @@ /** + * \file * \author Norihiro Watanabe * \date 2012-08-03 * diff --git a/Tests/ParameterLib/Parameter.cpp b/Tests/ParameterLib/Parameter.cpp index 84c0f11d84ab9321e22b7f7990fa093eac6243df..11c718521c4019a8c229a73dedc28d546f2ee3ac 100644 --- a/Tests/ParameterLib/Parameter.cpp +++ b/Tests/ParameterLib/Parameter.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/ProcessLib/ComponentTransport/TestLookupTable.cpp b/Tests/ProcessLib/ComponentTransport/TestLookupTable.cpp index a0e3baf214131a0e554a5f2101d08295b1ce22b9..fe27260b08f0d4c49c99b9b2bb6573e7900db7f5 100644 --- a/Tests/ProcessLib/ComponentTransport/TestLookupTable.cpp +++ b/Tests/ProcessLib/ComponentTransport/TestLookupTable.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/ProcessLib/RichardsMechanics/MicroporosityComputation.cpp b/Tests/ProcessLib/RichardsMechanics/MicroporosityComputation.cpp index 5a383de0ac63eca8ee4dc2d2760bb644438b6631..93ff7e42dadcf29bc61670ad8cce2417fe76200c 100644 --- a/Tests/ProcessLib/RichardsMechanics/MicroporosityComputation.cpp +++ b/Tests/ProcessLib/RichardsMechanics/MicroporosityComputation.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/ProcessLib/TestJacobianAssembler.cpp b/Tests/ProcessLib/TestJacobianAssembler.cpp index 1abb373aa5483b10f3d9b995c9a12b3b9eb28613..e7c8163d0452de1adace4bda94790630828eee48 100644 --- a/Tests/ProcessLib/TestJacobianAssembler.cpp +++ b/Tests/ProcessLib/TestJacobianAssembler.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/ProcessLib/TestProcessLibOutput.cpp b/Tests/ProcessLib/TestProcessLibOutput.cpp index c8c082c64914df0ccf27b71dacb5423280db217d..87d72d812535ac2e9b1830a19f3720808100d0a7 100644 --- a/Tests/ProcessLib/TestProcessLibOutput.cpp +++ b/Tests/ProcessLib/TestProcessLibOutput.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/ProcessLib/TestTransposeInplace.cpp b/Tests/ProcessLib/TestTransposeInplace.cpp index de33c45cc0b36d37fa8d7553269500bbafa4b2c1..858545e3dbeeef1d4858c694c7daa1f0a4ae7e79 100644 --- a/Tests/ProcessLib/TestTransposeInplace.cpp +++ b/Tests/ProcessLib/TestTransposeInplace.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/TestTestTools.cpp b/Tests/TestTestTools.cpp index 6cbd86c3161a36a1d1562b1630d3c679f74c7b6a..fe8e1d680868d71e2284f7e86be23bf5cfd3f455 100644 --- a/Tests/TestTestTools.cpp +++ b/Tests/TestTestTools.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/TestTools.cpp b/Tests/TestTools.cpp index 451326c7b78e744630e51b4357004802f4d3906a..ea6225af84b87bfe62c8a96b7fd45d77834c98b1 100644 --- a/Tests/TestTools.cpp +++ b/Tests/TestTools.cpp @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License. diff --git a/Tests/TestTools.h b/Tests/TestTools.h index ac8f8c06c35a2d18201889e90fc22491c4cc487b..56920e6630d7480880a1060425474942e0fb0f8d 100644 --- a/Tests/TestTools.h +++ b/Tests/TestTools.h @@ -2,7 +2,6 @@ * \file * \author Norihiro Watanabe * \date 2013-04-16 - * \brief * * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) diff --git a/Tests/VectorUtils.h b/Tests/VectorUtils.h index ed4cac860e09805723d7d0dd52b29f4893d3b10e..0a9607a1323936f06a89e4d509bd3f815e8aeddb 100644 --- a/Tests/VectorUtils.h +++ b/Tests/VectorUtils.h @@ -1,4 +1,5 @@ /** + * \file * \copyright * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org) * Distributed under a Modified BSD License.