GEOS
VTKWellGenerator.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2024 Total, S.A
7  * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
8  * Copyright (c) 2023-2024 Chevron
9  * Copyright (c) 2019- GEOS/GEOSX Contributors
10  * All rights reserved
11  *
12  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
13  * ------------------------------------------------------------------------------------------------------------
14  */
15 
20 #ifndef GEOS_MESH_GENERATORS_VTKWELLGENERATOR_HPP
21 #define GEOS_MESH_GENERATORS_VTKWELLGENERATOR_HPP
22 
23 #include "mesh/generators/WellGeneratorBase.hpp"
24 #include "dataRepository/Group.hpp"
25 #include "codingUtilities/Utilities.hpp"
26 #include "common/DataTypes.hpp"
27 
29 
30 #include <vtkDataSet.h>
31 
32 namespace geos
33 {
34 
39 class VTKWellGenerator final : public WellGeneratorBase
40 {
41 public:
42 
47 
53  VTKWellGenerator( const string & name,
54  Group * const parent );
55 
60  static string catalogName() { return "VTKWell"; }
61 
63 
64 
65 private:
66 
68  struct viewKeyStruct
69  {
70  constexpr static char const * filePathString() { return "file"; }
71  };
73 
74 
78  void fillPolylineDataStructure( ) override;
79 
80 
82  Path m_filePath;
83 
84 };
85 
86 } // namespace geos
87 
88 #endif /* GEOS_MESH_GENERATORS_VTKWELLGENERATOR_HPP */
The VTKWellGenerator class provides a class implementation of VTK generated well.
VTKWellGenerator(const string &name, Group *const parent)
Main constructor for VTKWellGenerator base class.
static string catalogName()
Return the name of the VTKWellGenerator in object Catalog.
constexpr char const filePathString[]
constexpr variable to hold name for inserting the file path into the xml file.
Definition: xmlWrapper.hpp:276