IOSS 2.0

Ioss_Transform.h
Go to the documentation of this file.
1 // Copyright(C) 1999-2017 National Technology & Engineering Solutions
2 // of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with
3 // NTESS, the U.S. Government retains certain rights in this software.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above
13 // copyright notice, this list of conditions and the following
14 // disclaimer in the documentation and/or other materials provided
15 // with the distribution.
16 //
17 // * Neither the name of NTESS nor the names of its
18 // contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
33 #ifndef IOSS_Ioss_Transform_h
34 #define IOSS_Ioss_Transform_h
35
36 #include <Ioss_CodeTypes.h>
37 #include <functional> // for less
38 #include <map> // for map, map<>::value_compare
39 #include <string> // for string
40 #include <vector> // for vector
41
42 namespace Ioss {
43 class Field;
44 } // namespace Ioss
45 namespace Ioss {
46 class VariableType;
47 } // namespace Ioss
48 namespace Iotr {
49 class Factory;
50 } // namespace Iotr
51
52 namespace Ioss {
53 } // namespace Ioss
54 namespace Ioss {
55 class Transform
56 {
57 public:
58 virtual ~Transform();
59 virtual const Ioss::VariableType *output_storage(const Ioss::VariableType *in) const = 0;
60 virtual int output_count(int in) const = 0;
61
62 bool execute(const Ioss::Field &field, void *data);
63
64 virtual void set_property(const std::string &name, int value);
65 virtual void set_property(const std::string &name, double value);
66 virtual void set_properties(const std::string &name, const std::vector<int> &values);
67 virtual void set_properties(const std::string &name, const std::vector<double> &values);
68
69 protected:
70 Transform();
71
72 virtual bool internal_execute(const Ioss::Field &field, void *data) = 0;
73 };
74 } // namespace Ioss
75
76 namespace Iotr {
77 using FactoryMap = std::map<std::string, Factory *, std::less<std::string>>;
78
79 class Factory
80 {
81 public:
82 virtual ~Factory() = default;
83 static Ioss::Transform *create(const std::string &type);
84
85 static int describe(Ioss::NameList *names);
86
87 protected:
88 explicit Factory(const std::string &type);
89 virtual Ioss::Transform *make(const std::string &) const = 0;
90 static void alias(const std::string &base, const std::string &syn);
91
92 private:
93 static FactoryMap *registry();
94 };
95 } // namespace Iotr
96
97 #endif // IOSS_Ioss_Transform_h
Ioss::NameList
std::vector< std::string > NameList
Definition: Ioss_CodeTypes.h:45
Ioss_CodeTypes.h
Iotr::Factory::Factory
Factory(const std::string &type)
Definition: Iotr_Factory.C:78
Ioss::Transform::execute
bool execute(const Ioss::Field &field, void *data)
Definition: Ioss_Transform.C:44
Iotr
A namespace for Ioss transformations.
Definition: Ioss_Transform.h:48
Ioss
The main namespace for the Ioss library.
Definition: Ioad_DatabaseIO.C:66
Ioss::Transform::~Transform
virtual ~Transform()
Ioss::Transform
Definition: Ioss_Transform.h:55
Iotr::Factory::alias
static void alias(const std::string &base, const std::string &syn)
Definition: Iotr_Factory.C:80
Iotr::Factory::registry
static FactoryMap * registry()
Definition: Iotr_Factory.C:86
Ioss::Transform::output_storage
virtual const Ioss::VariableType * output_storage(const Ioss::VariableType *in) const =0
Iotr::Factory::~Factory
virtual ~Factory()=default
Ioss::Transform::set_properties
virtual void set_properties(const std::string &name, const std::vector< int > &values)
Definition: Ioss_Transform.C:51
Iotr::FactoryMap
std::map< std::string, Factory *, std::less< std::string > > FactoryMap
Definition: Ioss_Transform.h:77
Ioss::VariableType
A generic variable type.
Definition: Ioss_VariableType.h:86
Iotr::Factory
Definition: Ioss_Transform.h:79
Iotr::Factory::create
static Ioss::Transform * create(const std::string &type)
Definition: Iotr_Factory.C:43
Ioss::Transform::internal_execute
virtual bool internal_execute(const Ioss::Field &field, void *data)=0
Iotr::Factory::describe
static int describe(Ioss::NameList *names)
Definition: Iotr_Factory.C:67
anonymous_namespace{cth_pressure_map.C}::data
std::vector< char > data
Definition: cth_pressure_map.C:73
anonymous_namespace{io_info.C}::name
std::string name(Ioss::GroupingEntity *entity)
Definition: io_info.C:89
Ioss::Field
Holds metadata for bulk data associated with a GroupingEntity.
Definition: Ioss_Field.h:47
Iotr::Factory::make
virtual Ioss::Transform * make(const std::string &) const =0
Ioss::Transform::Transform
Transform()
Ioss::Transform::output_count
virtual int output_count(int in) const =0
Ioss::Transform::set_property
virtual void set_property(const std::string &name, int value)
Definition: Ioss_Transform.C:49