Cantera  2.1.2
Cantera.h
Go to the documentation of this file.
1 /**
2  * @file Cantera.h
3  * Basic include file to be used in all Cantera application environments.
4  * @deprecated To be removed in Cantera 2.2. Applications should include
6  */
7
8 /*
9  * $Revision: 923$
10  * $Date: 2012-01-03 10:05:28 -0700 (Tue, 03 Jan 2012)$
11  */
12
13 // Copyright 2001 California Institute of Technology
14
15 /*
16  * Note, this include should be the first include that code containing the
17  * Cantera namespace sees when in the Cantera application environment.
18  */
19
20 #ifndef CANTERA_H_INCL
21 #define CANTERA_H_INCL
22
23 // If we are using this file, then we are in the Cantera Apps environment.
24 // Define a variable to signify this fact.
25 #ifndef CANTERA_APP
26 #define CANTERA_APP
27 #endif
28
29 // define the presence of the Cantera_CXX namespace
30 namespace Cantera_CXX{ }
31
32 // Include global typedefs and values for physical constants using SI units
33 #include "base/ct_defs.h"
34
35 // some useful functions
36 #include "base/global.h"
37
38 // the CanteraError exception class
39 #include "base/ctexceptions.h"
40
41 // The Cantera logger class
42 #include "base/logger.h"
43
44 // Include the timer
45 #include "base/clockWC.h"
46
47 // Include routines for reading and writing XML files
48 #include "base/xml.h"
49
50 // Include string utility routines
51 #include "base/stringUtils.h"
52
53 // Include the array object
54 #include "base/Array.h"
55
56 #endif
57
58
Declarations for a simple class that implements an Ansi C wall clock timer (see Cantera::clockWC).
This file contains definitions of terms that are used in internal routines and are unlikely to need m...
This file contains definitions for utility functions and text for modules, inputfiles, logs, textlogs, HTML_logs (see Input File Handling, Diagnostic Output, Writing messages to the screen and Writing HTML Logfiles).