IOSS 2.0

Ioss_DBUsage.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_DBUsage_h
34 #define IOSS_Ioss_DBUsage_h
35
36 namespace Ioss {
37
38 /** \brief Specifies how an Ioss::DatabaseIO object will be used.
39 */
40 enum DatabaseUsage {
41 WRITE_RESTART = 1, /**< The current state of the simulation, including model and field data
42 will be written to this database. */
43 READ_RESTART = 2, /**< A previous state of the simulation, including model and field data
44 will be read from this database. */
45 WRITE_RESULTS = 4, /**< Mesh-based results data, such as nodal displacements, will be written
46 to this database. */
47 READ_MODEL = 8, /**< Model data such as node coordinates, element connectivities will be read
48 from this database. */
49 WRITE_HISTORY =
50 16, /**< Global results data, such as total energy, will be written to this database. */
51 WRITE_HEARTBEAT =
52 32 /**< Text-based results data for particular nodes, edges, faces, elements,
53 or global variables at particular times will be written to this database. */
54 };
55
56 enum IfDatabaseExistsBehavior {
57 DB_OVERWRITE,
58 DB_APPEND,
59 DB_APPEND_GROUP,
60 DB_ABORT,
61 DB_ADD_SUFFIX,
62 DB_ADD_SUFFIX_OVERWRITE
63 }; // Used if topology change in DB_OVERWRITE mode
64
65 inline bool is_input_event(Ioss::DatabaseUsage db_usage)
66 {
67 return db_usage == Ioss::READ_MODEL || db_usage == Ioss::READ_RESTART;
68 }
69 } // namespace Ioss
70 #endif // IOSS_Ioss_DBUsage_h
Ioss::READ_MODEL
Definition: Ioss_DBUsage.h:47
Ioss
The main namespace for the Ioss library.
Definition: Iocgns_DatabaseIO.h:50
Ioss::DB_OVERWRITE
Definition: Ioss_DBUsage.h:57
Ioss::DB_ABORT
Definition: Ioss_DBUsage.h:60
Ioss::DB_APPEND
Definition: Ioss_DBUsage.h:58
Ioss::DB_ADD_SUFFIX
Definition: Ioss_DBUsage.h:61
Ioss::WRITE_RESTART
Definition: Ioss_DBUsage.h:41
Ioss::WRITE_HISTORY
Definition: Ioss_DBUsage.h:49
Ioss::DatabaseUsage
DatabaseUsage
Specifies how an Ioss::DatabaseIO object will be used.
Definition: Ioss_DBUsage.h:40
Ioss::READ_RESTART
Definition: Ioss_DBUsage.h:43
Ioss::is_input_event
bool is_input_event(Ioss::DatabaseUsage db_usage)
Definition: Ioss_DBUsage.h:65
Ioss::WRITE_HEARTBEAT
Definition: Ioss_DBUsage.h:51
Ioss::WRITE_RESULTS
Definition: Ioss_DBUsage.h:45
Ioss::DB_ADD_SUFFIX_OVERWRITE
Definition: Ioss_DBUsage.h:62
Ioss::DB_APPEND_GROUP
Definition: Ioss_DBUsage.h:59
Ioss::IfDatabaseExistsBehavior
IfDatabaseExistsBehavior
Definition: Ioss_DBUsage.h:56