box.hpp

Go to the documentation of this file.

/*------------------------------- phasicFlow ---------------------------------
      O        C enter of
     O O       E ngineering and
    O   O      M ultiscale modeling of
   OOOOOOO     F luid flow       
------------------------------------------------------------------------------
  Copyright (C): www.cemf.ir
  email: hamid.r.norouzi AT gmail.com
------------------------------------------------------------------------------  
Licence:
  This file is part of phasicFlow code. It is a free software for simulating 
  granular and multiphase flows. You can redistribute it and/or modify it under
  the terms of GNU General Public License v3 or any other later versions. 
 
  phasicFlow is distributed to help others in their research in the field of 
  granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-----------------------------------------------------------------------------*/
 
#ifndef __box_hpp__
#define __box_hpp__
 
#include "types.hpp"
#include "dictionary.hpp"
#include "iIstream.hpp"
#include "iOstream.hpp"
 
namespace pFlow
{
 
class box
{
protected:
    
    // - min point
    realx3  min_{0,0,0};
    
    // - max point 
    realx3  max_{1,1,1};
 
public:
 
    // - type info
    TypeInfoNV("box");
 
        INLINE_FUNCTION_HD 
        box() = default;
 
        INLINE_FUNCTION_HD 
        box(const realx3& minP, const realx3& maxP)
        :
            min_(minP),
            max_(maxP)
        {}
        
 
        FUNCTION_H
        explicit box(const dictionary& dict);
 
        FUNCTION_H
        explicit box(iIstream& is);
 
        INLINE_FUNCTION_HD
        box(const box&) = default;
 
        INLINE_FUNCTION_HD
        box(box&&) = default;
 
        INLINE_FUNCTION_HD
        box& operator=(const box&) = default;
 
        INLINE_FUNCTION_HD
        box& operator=(box&&) = default;
 
        INLINE_FUNCTION_HD
        ~box()=default;
 
 
        
        INLINE_FUNCTION_HD
        bool isInside(const realx3& point)const
        {
            // box planes are also included as the inside of the box 
            return point >= min_ && point <=max_;
        }
 
        INLINE_FUNCTION_HD
        const realx3& minPoint()const
        {
            return min_;
        }
 
        INLINE_FUNCTION_HD
        const realx3& maxPoint()const
        {
            return max_;
        }
 
        INLINE_FUNCTION_HD
        realx3& minPoint()
        {
            return min_;
        }
 
        INLINE_FUNCTION_HD
        realx3& maxPoint()
        {
            return max_;
        }
 
        FUNCTION_H
        bool read(iIstream & is);
 
        FUNCTION_H
        bool write(iOstream& os)const;
 
        FUNCTION_H
        bool read(const dictionary& dict);
 
        FUNCTION_H
        bool write(dictionary& dict)const;
};
 
FUNCTION_H
iIstream& operator >>(iIstream& is, box& b);
 
FUNCTION_H
iOstream& operator << (iOstream& os, const box& b);
 
INLINE_FUNCTION_HD
bool equal(const box& b1, const box& b2, real tol = smallValue)
{
    return  equal(b1.minPoint(), b2.minPoint(), tol) && 
            equal(b1.maxPoint(), b2.maxPoint(), tol);
}
 
INLINE_FUNCTION_HD
bool operator ==(const box& b1, const box& b2)
{
    return equal(b1, b2);
}
 
INLINE_FUNCTION_HD
box extendBox(const box& b, const realx3& dl)
{
    return box(b.minPoint()-dl , b.maxPoint()+dl);
}
 
}
 
 
#endif