src/OpenFOAM/meshes/boundBox/boundBoxI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "boundBox.H"
  27 #include "pointField.H"
  28
  29
  30 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  31
  32 inline Foam::boundBox::boundBox()
  33 :
  34     min_(point::zero),
  35     max_(point::zero)
  36 {}
  37
  38
  39 inline Foam::boundBox::boundBox(const point& min, const point& max)
  40 :
  41     min_(min),
  42     max_(max)
  43 {}
  44
  45
  46 inline Foam::boundBox::boundBox(Istream& is)
  47 {
  48     operator>>(is, *this);
  49 }
  50
  51
  52 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  53
  54 inline const Foam::point& Foam::boundBox::min() const
  55 {
  56     return min_;
  57 }
  58
  59
  60 inline const Foam::point& Foam::boundBox::max() const
  61 {
  62     return max_;
  63 }
  64
  65
  66 inline Foam::point& Foam::boundBox::min()
  67 {
  68     return min_;
  69 }
  70
  71
  72 inline Foam::point& Foam::boundBox::max()
  73 {
  74     return max_;
  75 }
  76
  77
  78 inline Foam::point Foam::boundBox::midpoint() const
  79 {
  80     return 0.5 * (max_ + min_);
  81 }
  82
  83
  84 inline Foam::vector Foam::boundBox::span() const
  85 {
  86     return (max_ - min_);
  87 }
  88
  89
  90 inline Foam::scalar Foam::boundBox::mag() const
  91 {
  92     return ::Foam::mag(max_ - min_);
  93 }
  94
  95
  96 inline Foam::scalar Foam::boundBox::volume() const
  97 {
  98     return cmptProduct(span());
  99 }
 100
 101
 102 inline Foam::scalar Foam::boundBox::minDim() const
 103 {
 104     return cmptMin(span());
 105 }
 106
 107
 108 inline Foam::scalar Foam::boundBox::maxDim() const
 109 {
 110     return cmptMax(span());
 111 }
 112
 113
 114 inline Foam::scalar Foam::boundBox::avgDim() const
 115 {
 116     return cmptAv(span());
 117 }
 118
 119
 120 inline bool Foam::boundBox::overlaps(const boundBox& bb) const
 121 {
 122     return
 123     (
 124         bb.max_.x() >= min_.x() && bb.min_.x() <= max_.x()
 125      && bb.max_.y() >= min_.y() && bb.min_.y() <= max_.y()
 126      && bb.max_.z() >= min_.z() && bb.min_.z() <= max_.z()
 127     );
 128 }
 129
 130
 131 inline bool Foam::boundBox::contains(const point& pt) const
 132 {
 133     return
 134     (
 135         pt.x() >= min_.x() && pt.x() <= max_.x()
 136      && pt.y() >= min_.y() && pt.y() <= max_.y()
 137      && pt.z() >= min_.z() && pt.z() <= max_.z()
 138     );
 139 }
 140
 141
 142 // this.bb fully contains bb
 143 inline bool Foam::boundBox::contains(const boundBox& bb) const
 144 {
 145     return contains(bb.min()) && contains(bb.max());
 146 }
 147
 148
 149 inline bool Foam::boundBox::containsInside(const point& pt) const
 150 {
 151     return
 152     (
 153         pt.x() > min_.x() && pt.x() < max_.x()
 154      && pt.y() > min_.y() && pt.y() < max_.y()
 155      && pt.z() > min_.z() && pt.z() < max_.z()
 156     );
 157 }
 158
 159
 160 // * * * * * * * * * * * * * * * Friend Operators  * * * * * * * * * * * * * //
 161
 162 inline bool Foam::operator==(const boundBox& a, const boundBox& b)
 163 {
 164     return (a.min_ == b.min_) && (a.max_ == b.max_);
 165 }
 166
 167
 168 inline bool Foam::operator!=(const boundBox& a, const boundBox& b)
 169 {
 170     return !(a == b);
 171 }
 172
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //