# 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 "types.hpp"
#include "virtualConstructor.hpp"
namespace pFlow
{
class dictionary;
class peakableRegion
{
public:
// type info
TypeInfo("peakableRegion");
peakableRegion(const word& type, const dictionary& dict);
create_vCtor(
peakableRegion,
word,
(const word& type, const dictionary& dict),
(type, dict)
);
virtual uniquePtr<peakableRegion> clone() const = 0;
virtual peakableRegion* clonePtr() const = 0;
virtual ~peakableRegion() = default;
virtual bool isInside(const realx3& point) const = 0;
virtual realx3 peek() const = 0;
virtual const realx3& minPoint()const = 0;
virtual const realx3& maxPoint()const = 0;
virtual bool read(const dictionary& dict) = 0;
virtual bool write(dictionary& dict) const = 0;
// - static create
static uniquePtr<peakableRegion>
create(const word& type, const dictionary& dict);
};
} // namespace pFlow
#endif
pFlow::peakableRegion::minPoint
virtual const realx3 & minPoint() const =0
pFlow::peakableRegion::clonePtr
virtual peakableRegion * clonePtr() const =0
types.hpp
pFlow::peakableRegion::peakableRegion
peakableRegion(const word &type, const dictionary &dict)
Definition: peakableRegion.cpp:25
pFlow::peakableRegion::write
virtual bool write(dictionary &dict) const =0
pFlow::word
std::string word
Definition: builtinTypes.hpp:64
pFlow::peakableRegion::read
virtual bool read(const dictionary &dict)=0
pFlow::peakableRegion::isInside
virtual bool isInside(const realx3 &point) const =0
pFlow::peakableRegion::~peakableRegion
virtual ~peakableRegion()=default
pFlow
Definition: demGeometry.hpp:27
pFlow::peakableRegion::clone
virtual uniquePtr< peakableRegion > clone() const =0
virtualConstructor.hpp
pFlow::peakableRegion::create
static uniquePtr< peakableRegion > create(const word &type, const dictionary &dict)
Definition: peakableRegion.cpp:36
pFlow::peakableRegion::peek
virtual realx3 peek() const =0
pFlow::peakableRegion::create_vCtor
create_vCtor(peakableRegion, word,(const word &type, const dictionary &dict),(type, dict))
pFlow::uniquePtr
Definition: uniquePtr.hpp:42
pFlow::peakableRegion::maxPoint
virtual const realx3 & maxPoint() const =0
pFlow::triple< real >
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
pFlow::peakableRegion::TypeInfo
TypeInfo("peakableRegion")