GEOSX
VTKWellGenerator.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
7  * Copyright (c) 2018-2020 Total, S.A
8  * Copyright (c) 2019- GEOSX Contributors
9  * All rights reserved
10  *
11  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
12  * ------------------------------------------------------------------------------------------------------------
13  */
14 
19 #ifndef GEOS_MESH_GENERATORS_VTKWELLGENERATOR_HPP
20 #define GEOS_MESH_GENERATORS_VTKWELLGENERATOR_HPP
21 
22 #include "mesh/generators/WellGeneratorBase.hpp"
23 #include "dataRepository/Group.hpp"
24 #include "codingUtilities/Utilities.hpp"
25 #include "common/DataTypes.hpp"
26 
28 
29 #include <vtkDataSet.h>
30 
31 namespace geos
32 {
33 
38 class VTKWellGenerator final : public WellGeneratorBase
39 {
40 public:
41 
46 
52  VTKWellGenerator( const string & name,
53  Group * const parent );
54 
59  static string catalogName() { return "VTKWell"; }
60 
62 
63 
64 private:
65 
67  struct viewKeyStruct
68  {
69  constexpr static char const * filePathString() { return "file"; }
70  };
72 
73 
77  void fillPolylineDataStructure( ) override;
78 
79 
81  Path m_filePath;
82 
83 };
84 
85 } // namespace geos
86 
87 #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:274