# PhasicFlow: src/phasicFlow/structuredData/peakableRegion/PeakableRegion/PeakableRegion.hpp Source File
PhasicFlow is an open-source parallel DEM (discrete element method) package for simulating granular flow. It is developed in C++ and can be exectued on both GPU (like CUDA) and CPU.

PeakableRegion.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 __PeakableRegion_hpp__
#define __PeakableRegion_hpp__
#include "dictionary.hpp"
#include "geometricRegion.hpp"
#include "peakableRegion.hpp"
namespace pFlow
{
template<typename GeomType>
class PeakableRegion : public peakableRegion
{
public:
using RegionType = geometricRegion<GeomType>;
using GeometryType = typename RegionType::GeometryType;
private:
RegionType region_;
public:
// type info
TypeInfoTemplate11("peakable", GeometryType);
PeakableRegion(const word& type, const dictionary& dict);
add_vCtor(peakableRegion, PeakableRegion, word);
virtual uniquePtr<peakableRegion> clone() const override
{
return makeUnique<PeakableRegion<GeomType>>(*this);
}
virtual peakableRegion* clonePtr() const override
{
return new PeakableRegion<GeomType>(*this);
}
virtual ~PeakableRegion() = default;
bool isInside(const realx3& point) const override;
realx3 peek() const override;
const realx3& minPoint()const override
{
return region_.minPoint();
}
const realx3& maxPoint()const override
{
return region_.maxPoint();
}
virtual bool read(const dictionary& dict) override;
virtual bool write(dictionary& dict) const override;
};
} // pFlow
#include "PeakableRegion.cpp"
#endif
pFlow::PeakableRegion::~PeakableRegion
virtual ~PeakableRegion()=default
pFlow::PeakableRegion::read
virtual bool read(const dictionary &dict) override
Definition: PeakableRegion.cpp:52
pFlow::word
std::string word
Definition: builtinTypes.hpp:64
pFlow::geometricRegion::maxPoint
const auto & maxPoint() const
Definition: geometricRegion.hpp:70
pFlow::PeakableRegion::PeakableRegion
PeakableRegion(const word &type, const dictionary &dict)
Definition: PeakableRegion.cpp:24
pFlow::PeakableRegion::add_vCtor
add_vCtor(peakableRegion, PeakableRegion, word)
pFlow::PeakableRegion::minPoint
const realx3 & minPoint() const override
Definition: PeakableRegion.hpp:72
pFlow::geometricRegion::minPoint
const auto & minPoint() const
Definition: geometricRegion.hpp:65
pFlow
Definition: demGeometry.hpp:27
pFlow::geometricRegion::GeometryType
GeomType GeometryType
Definition: geometricRegion.hpp:37
pFlow::PeakableRegion::maxPoint
const realx3 & maxPoint() const override
Definition: PeakableRegion.hpp:77
pFlow::PeakableRegion::TypeInfoTemplate11
TypeInfoTemplate11("peakable", GeometryType)
pFlow::PeakableRegion::region_
RegionType region_
Definition: PeakableRegion.hpp:42
pFlow::PeakableRegion::GeometryType
typename RegionType::GeometryType GeometryType
Definition: PeakableRegion.hpp:38
dictionary.hpp
PeakableRegion.cpp
pFlow::PeakableRegion::clone
virtual uniquePtr< peakableRegion > clone() const override
Definition: PeakableRegion.hpp:54
geometricRegion.hpp
pFlow::PeakableRegion::clonePtr
virtual peakableRegion * clonePtr() const override
Definition: PeakableRegion.hpp:59
peakableRegion.hpp
pFlow::geometricRegion
Definition: geometricRegion.hpp:33
pFlow::PeakableRegion::isInside
bool isInside(const realx3 &point) const override
Definition: PeakableRegion.cpp:37
pFlow::uniquePtr
Definition: uniquePtr.hpp:42
pFlow::triple< real >
pFlow::PeakableRegion::write
virtual bool write(dictionary &dict) const override
Definition: PeakableRegion.cpp:58
pFlow::PeakableRegion::peek
realx3 peek() const override
Definition: PeakableRegion.cpp:46
pFlow::PeakableRegion
Definition: PeakableRegion.hpp:32
pFlow::peakableRegion
Definition: peakableRegion.hpp:32
pFlow::dictionary
Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or ar...
Definition: dictionary.hpp:67