PeakableRegion< RegionType > Class Template Reference
Inheritance diagram for PeakableRegion< RegionType >:
Collaboration diagram for PeakableRegion< RegionType >:

Public Member Functions

 TypeInfoTemplate ("peakableRegion", RegionType)
 
 PeakableRegion (const word &type, const dictionary &dict)
 
 add_vCtor (peakableRegion, PeakableRegion, word)
 
virtual uniquePtr< peakableRegionclone () const override
 
virtual peakableRegionclonePtr () const override
 
virtual ~PeakableRegion ()=default
 
virtual bool isInside (const realx3 &point) const override
 
virtual realx3 peek () const override
 
virtual bool read (const dictionary &dict) override
 
virtual bool write (dictionary &dict) const override
 
- Public Member Functions inherited from peakableRegion
 TypeInfo ("peakableRegion")
 
 peakableRegion (const word &type, const dictionary &dict)
 
 create_vCtor (peakableRegion, word,(const word &type, const dictionary &dict),(type, dict))
 
virtual ~peakableRegion ()=default
 

Protected Attributes

RegionType region_
 

Additional Inherited Members

- Static Public Member Functions inherited from peakableRegion
static uniquePtr< peakableRegioncreate (const word &type, const dictionary &dict)
 

Detailed Description

template<typename RegionType>
class pFlow::PeakableRegion< RegionType >

Definition at line 36 of file PeakableRegion.hpp.

Constructor & Destructor Documentation

◆ PeakableRegion()

PeakableRegion ( const word type,
const dictionary dict 
)

Definition at line 24 of file PeakableRegion.cpp.

◆ ~PeakableRegion()

virtual ~PeakableRegion ( )
virtualdefault

Member Function Documentation

◆ TypeInfoTemplate()

TypeInfoTemplate ( "peakableRegion"  ,
RegionType   
)

◆ add_vCtor()

add_vCtor ( peakableRegion  ,
PeakableRegion< RegionType >  ,
word   
)

◆ clone()

virtual uniquePtr<peakableRegion> clone ( ) const
inlineoverridevirtual

Implements peakableRegion.

Definition at line 58 of file PeakableRegion.hpp.

◆ clonePtr()

virtual peakableRegion* clonePtr ( ) const
inlineoverridevirtual

Implements peakableRegion.

Definition at line 63 of file PeakableRegion.hpp.

◆ isInside()

bool isInside ( const realx3 point) const
overridevirtual

Implements peakableRegion.

Definition at line 37 of file PeakableRegion.cpp.

◆ peek()

pFlow::realx3 peek
overridevirtual

Implements peakableRegion.

Definition at line 46 of file PeakableRegion.cpp.

◆ read()

bool read ( const dictionary dict)
overridevirtual

Implements peakableRegion.

Definition at line 52 of file PeakableRegion.cpp.

◆ write()

bool write ( dictionary dict) const
overridevirtual

Implements peakableRegion.

Definition at line 58 of file PeakableRegion.cpp.

Member Data Documentation

◆ region_

RegionType region_
protected

Definition at line 42 of file PeakableRegion.hpp.


The documentation for this class was generated from the following files: