Debian Codegraph @

include/deal.II/vtk/utilities.h

raw
1 // ------------------------------------------------------------------------
2 //
3 // SPDX-License-Identifier: LGPL-2.1-or-later
4 // Copyright (C) 2023 - 2025 by the deal.II authors
5 //
6 // This file is part of the deal.II library.
7 //
8 // Part of the source code is dual licensed under Apache-2.0 WITH
9 // LLVM-exception OR LGPL-2.1-or-later. Detailed license information
10 // governing the source code and code contributions can be found in
11 // LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
12 //
13 // ------------------------------------------------------------------------
14
15 #ifndef dealii_vtk_utilities_h
16 #define dealii_vtk_utilities_h
17
18 #include <deal.II/base/config.h>
19
20 #include <deal.II/base/exceptions.h>
21 #include <deal.II/base/point.h>
22
23 #ifdef DEAL_II_WITH_VTK
24
25 # include <vtkDoubleArray.h>
26
27 DEAL_II_NAMESPACE_OPEN
28
29 /**
30 * Interface to the Visualization Toolkit (VTK).
31 *
32 * VTK is an open-source, freely available software system for 3D computer
33 * graphics, modeling, image processing, volume rendering, scientific
34 * visualization, and 2D plotting.
35
36 * It supports a wide variety of visualization algorithms and advanced
37 * modeling techniques, and it takes advantage of both threaded and distributed
38 * memory parallel processing for speed and scalability, respectively.
39 *
40 * You can learn more about the VTK library at https://vtk.org/
41 */
42 namespace VTKWrappers
43 {
44 /**
45 * Convert from a deal.II Point to a VTK double array.
46 *
47 * @tparam dim Dimension of the point
48 * @param [in] p An input deal.II Point<dim>
49 * @return A VTK smart pointer to the data array.
50 */
51 template <int dim>
52 inline vtkSmartPointer<vtkDoubleArray>
53 dealii_point_to_vtk_array(const dealii::Point<dim> &p);
54
55 # ifndef DOXYGEN
56 // Template implementations
57
58 template <int dim>
59 inline vtkSmartPointer<vtkDoubleArray>
60 dealii_point_to_vtk_array(const dealii::Point<dim> &p)
61 {
62 vtkSmartPointer<vtkDoubleArray> p_vtk =
63 vtkSmartPointer<vtkDoubleArray>::New();
64
65 p_vtk->SetNumberOfComponents(dim);
66 p_vtk->SetNumberOfTuples(1);
67
68 for (int d = 0; d < dim; ++d)
69 p_vtk->FillComponent(d, p[d]);
70
71 return p_vtk;
72 }
73
74 # endif
75
76 } // namespace VTKWrappers
77
78 DEAL_II_NAMESPACE_CLOSE
79
80 #else
81
82 // Make sure the scripts that create the C++20 module input files have
83 // something to latch on if the preprocessor #ifdef above would
84 // otherwise lead to an empty content of the file.
85 DEAL_II_NAMESPACE_OPEN
86 DEAL_II_NAMESPACE_CLOSE
87
88 #endif
89 #endif