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 Vectors_hh_INCLUDED
49 : #define Vectors_hh_INCLUDED
50 :
51 : // ObjexxFCL Headers
52 : #include <ObjexxFCL/Array1D.hh>
53 :
54 : // EnergyPlus Headers
55 : #include <EnergyPlus/Data/BaseData.hh>
56 : #include <EnergyPlus/DataVectorTypes.hh>
57 : #include <EnergyPlus/EnergyPlus.hh>
58 :
59 : namespace EnergyPlus {
60 :
61 : // Fwd decl
62 : struct EnergyPlusData;
63 :
64 : namespace Vectors {
65 :
66 : // Using/Aliasing
67 : using DataVectorTypes::PlaneEq;
68 : using DataVectorTypes::Polyhedron;
69 : using DataVectorTypes::Vector;
70 : using DataVectorTypes::Vector_2d;
71 :
72 : // MODULE PARAMETER DEFINITIONS
73 :
74 : // Object Data
75 : extern Vector const XUnit;
76 : extern Vector const YUnit;
77 : extern Vector const ZUnit;
78 :
79 : // Functions
80 :
81 : Real64 AreaPolygon(int const n, Array1D<Vector> &p);
82 :
83 : Real64 VecSquaredLength(Vector const &vec);
84 :
85 : Real64 VecLength(Vector const &vec);
86 :
87 : Vector VecNegate(Vector const &vec);
88 :
89 : Vector VecNormalize(Vector const &vec);
90 :
91 : void VecRound(Vector &vec, Real64 const roundto);
92 :
93 : void DetermineAzimuthAndTilt(Array1D<Vector> const &Surf, // Surface Definition
94 : Real64 &Azimuth, // Outward Normal Azimuth Angle
95 : Real64 &Tilt, // Tilt angle of surface
96 : Vector &lcsx,
97 : Vector &lcsy,
98 : Vector &lcsz,
99 : Vector const &NewellSurfaceNormalVector);
100 :
101 : void PlaneEquation(Array1D<Vector> &verts, // Structure of the surface
102 : int const nverts, // Number of vertices in the surface
103 : PlaneEq &plane, // Equation of plane from inputs
104 : bool &error // returns true for degenerate surface
105 : );
106 :
107 : Real64 Pt2Plane(Vector const &pt, // Point for determining the distance
108 : PlaneEq const &pleq // Equation of the plane
109 : );
110 :
111 : void CreateNewellAreaVector(Array1D<Vector> const &VList, int const NSides, Vector &OutNewellAreaVector);
112 :
113 : void CreateNewellSurfaceNormalVector(Array1D<Vector> const &VList, int const NSides, Vector &OutNewellSurfaceNormalVector);
114 :
115 : void CompareTwoVectors(Vector const &vector1, // standard vector
116 : Vector const &vector2, // standard vector
117 : bool &areSame, // true if the two vectors are the same within specified tolerance
118 : Real64 const tolerance // specified tolerance
119 : );
120 :
121 : void CalcCoPlanarNess(Array1D<Vector> &Surf, int const NSides, bool &IsCoPlanar, Real64 &MaxDist, int &ErrorVertex);
122 :
123 : std::vector<int>
124 : PointsInPlane(Array1D<Vector> &BaseSurf, int const BaseSides, Array1D<Vector> const &QuerySurf, int const QuerySides, bool &ErrorFound);
125 :
126 : Real64 CalcPolyhedronVolume(EnergyPlusData const &state, Polyhedron const &Poly);
127 :
128 : } // namespace Vectors
129 :
130 : struct VectorsData : BaseGlobalStruct
131 : {
132 : Vectors::Vector p0 = Vectors::Vector(0.0, 0.0, 0.0);
133 :
134 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
135 : {
136 2126 : }
137 :
138 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
139 : {
140 1152 : }
141 :
142 2100 : void clear_state() override
143 : {
144 2100 : this->p0 = Vectors::Vector(0.0, 0.0, 0.0);
145 2100 : }
146 : };
147 :
148 : } // namespace EnergyPlus
149 :
150 : #endif
|
