FEM: vtk, tools, better comments in header file

This commit is contained in:
Bernd Hahnebach
2018-09-30 21:43:44 +02:00
committed by Yorik van Havre
parent c7252e5efd
commit 6410c28ddb

View File

@@ -37,46 +37,35 @@
namespace Fem
{
/*!
utitly class to import/export read/write vtk mesh and result
*/
// utility class to import/export read/write vtk mesh and result
class AppFemExport FemVTKTools
{
public:
/*!
FemMesh import from vtkUnstructuredGrid instance
*/
// extract data from vtkUnstructuredGrid instance and fill a FreeCAD FEM mesh object with that data
static void importVTKMesh(vtkSmartPointer<vtkDataSet> grid, FemMesh* mesh, float scale = 1.0);
/*!
FemMesh read from vtkUnstructuredGrid data file
*/
static FemMesh* readVTKMesh(const char* filename, FemMesh* mesh);
/*!
FemMesh export to vtkUnstructuredGrid instance
*/
static void exportVTKMesh(const FemMesh* mesh, vtkSmartPointer<vtkUnstructuredGrid> grid, float scale = 1.0);
/*!
FemMesh write to vtkUnstructuredGrid data file
*/
static void writeVTKMesh(const char* Filename, const FemMesh* mesh);
/*!
* FemResult import from vtkUnstructuredGrid object
*/
// extract data from FreCAD FEM mesh and fill a vtkUnstructuredGrid instance with that data
static void exportVTKMesh(const FemMesh* mesh, vtkSmartPointer<vtkUnstructuredGrid> grid, float scale = 1.0);
// extract data from vtkUnstructuredGrid object and fill a FreeCAD FEM result object with that data (needed by readResult)
static void importFreeCADResult(vtkSmartPointer<vtkDataSet> dataset, App::DocumentObject* result);
/*!
* FemResult export to vtkUnstructuredGrid object
*/
// extract data from a FreeCAD FEM result object and fill a vtkUnstructuredGrid object with that data (needed by writeResult)
static void exportFreeCADResult(const App::DocumentObject* result, vtkSmartPointer<vtkDataSet> grid);
/*!
* FemResult (activeObject or created if res= NULL) read from vtkUnstructuredGrid dataset file
*/
// FemMesh read from vtkUnstructuredGrid data file
static FemMesh* readVTKMesh(const char* filename, FemMesh* mesh);
// FemMesh write to vtkUnstructuredGrid data file
static void writeVTKMesh(const char* Filename, const FemMesh* mesh);
// FemResult (activeObject or created if res= NULL) read from vtkUnstructuredGrid dataset file
static App::DocumentObject* readResult(const char* Filename, App::DocumentObject* res = NULL);
/*!
* write FemResult (activeObject if res= NULL) to vtkUnstructuredGrid dataset file
*/
// write FemResult (activeObject if res= NULL) to vtkUnstructuredGrid dataset file
static void writeResult(const char* filename, const App::DocumentObject* res = NULL);
};