Line data Source code
1 : // EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University of Illinois,
2 : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
3 : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
4 : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
5 : // contributors. All rights reserved.
6 : //
7 : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
8 : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
9 : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
10 : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
11 : // derivative works, and perform publicly and display publicly, and to permit others to do so.
12 : //
13 : // Redistribution and use in source and binary forms, with or without modification, are permitted
14 : // provided that the following conditions are met:
15 : //
16 : // (1) Redistributions of source code must retain the above copyright notice, this list of
17 : // conditions and the following disclaimer.
18 : //
19 : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
20 : // conditions and the following disclaimer in the documentation and/or other materials
21 : // provided with the distribution.
22 : //
23 : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
24 : // the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
25 : // used to endorse or promote products derived from this software without specific prior
26 : // written permission.
27 : //
28 : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
29 : // without changes from the version obtained under this License, or (ii) Licensee makes a
30 : // reference solely to the software portion of its product, Licensee must refer to the
31 : // software as "EnergyPlus version X" software, where "X" is the version number Licensee
32 : // obtained under this License and may not use a different name for the software. Except as
33 : // specifically required in this Section (4), Licensee shall not use in a company name, a
34 : // product name, in advertising, publicity, or other promotional activities any name, trade
35 : // name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
36 : // similar designation, without the U.S. Department of Energy's prior written consent.
37 : //
38 : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
39 : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
40 : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
41 : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
42 : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
43 : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
44 : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
45 : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
46 : // POSSIBILITY OF SUCH DAMAGE.
47 :
48 : #ifndef MatrixDataManager_hh_INCLUDED
49 : #define MatrixDataManager_hh_INCLUDED
50 :
51 : // ObjexxFCL Headers
52 : #include <ObjexxFCL/Array1D.hh>
53 : #include <ObjexxFCL/Array2D.hh>
54 : #include <ObjexxFCL/Array2S.hh>
55 :
56 : // EnergyPlus Headers
57 : #include <EnergyPlus/Data/BaseData.hh>
58 : #include <EnergyPlus/DataGlobals.hh>
59 : #include <EnergyPlus/EnergyPlus.hh>
60 :
61 : namespace EnergyPlus {
62 :
63 : // Forward declarations
64 : struct EnergyPlusData;
65 :
66 : namespace MatrixDataManager {
67 :
68 : // Using/Aliasing
69 :
70 : // Data
71 : // MODULE PARAMETER DEFINITIONS:
72 : // INTEGER, PARAMETER :: OneDimensional = 1
73 : int constexpr TwoDimensional = 2;
74 : // INTEGER, PARAMETER :: ThreeDimensional = 3
75 :
76 : // DERIVED TYPE DEFINITIONS:
77 : // na
78 :
79 : // MODULE VARIABLE DECLARATIONS:
80 :
81 : // SUBROUTINE SPECIFICATIONS FOR MODULE <module_name>:
82 :
83 : // todo, flush out the following routines, see CurveManager for patterns
84 : // PUBLIC GetMatrixValue
85 : // PUBLIC GetMatrixCheck
86 : // PUBLIC GetMatrixType
87 : // PUBLIC GetMatrixMinMaxValues
88 : // PUBLIC SetMatrixOutputMinMaxValues
89 : // PUBLIC GetMatrixName
90 :
91 : // Types
92 :
93 : struct MatrixDataStruct
94 : {
95 : // Members
96 : std::string Name; // Matrix Name
97 : int MatrixType;
98 : // REAL(r64), DIMENSION(:), ALLOCATABLE :: Mat1D ! hold data if one dimensional
99 : Array2D<Real64> Mat2D; // hold data if two dimensional
100 : // REAL(r64), DIMENSION(:,:,:), Allocatable :: Mat3D ! hold data if three dimensional
101 :
102 : // Default Constructor
103 9 : MatrixDataStruct() : MatrixType(0)
104 : {
105 9 : }
106 : };
107 :
108 : // Object Data
109 :
110 : // Functions
111 :
112 : void GetMatrixInput(EnergyPlusData &state);
113 :
114 : int MatrixIndex(EnergyPlusData &state, std::string const &MatrixName);
115 :
116 : void Get2DMatrix(EnergyPlusData &state,
117 : int const Idx, // pointer index to location in MatData
118 : Array2S<Real64> Mat2D);
119 :
120 : void Get2DMatrixDimensions(EnergyPlusData &state,
121 : int const Idx, // pointer index to location in MatData
122 : int &NumRows,
123 : int &NumCols);
124 :
125 : } // namespace MatrixDataManager
126 :
127 : struct MatrixDataManagerData : BaseGlobalStruct
128 : {
129 :
130 : Array1D<MatrixDataManager::MatrixDataStruct> MatData;
131 : int NumMats; // number of matracies in input file
132 :
133 2128 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
134 : {
135 2128 : }
136 :
137 1153 : void init_state([[maybe_unused]] EnergyPlusData &state) override
138 : {
139 1153 : }
140 :
141 2102 : void clear_state() override
142 : {
143 2102 : MatData.clear();
144 2102 : NumMats = int();
145 2102 : }
146 : };
147 :
148 : } // namespace EnergyPlus
149 :
150 : #endif
|
