peakableRegion Class Reference

Inheritance diagram for peakableRegion:

Public Member Functions
	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 bool	read (const dictionary &dict)=0
virtual bool	write (dictionary &dict) const =0

Static Public Member Functions
static uniquePtr< peakableRegion >	create (const word &type, const dictionary &dict)

Detailed Description

Definition at line 35 of file peakableRegion.hpp.

Constructor & Destructor Documentation

peakableRegion()

peakableRegion	(	const word &	type,
		const dictionary &	dict
	)

Definition at line 26 of file peakableRegion.cpp.

References CONSUME_PARAM.

~peakableRegion()

virtual ~peakableRegion ( )

virtualdefault

Member Function Documentation

TypeInfo()

TypeInfo

(

"peakableRegion"

)

create_vCtor()

create_vCtor	(	peakableRegion	,
		word	,
		(const word &type, const dictionary &dict)	,
		(type, dict)
	)

clone()

virtual uniquePtr<peakableRegion> clone ( ) const

pure virtual

Implemented in PeakableRegion< RegionType >.

clonePtr()

virtual peakableRegion* clonePtr ( ) const

pure virtual

Implemented in PeakableRegion< RegionType >.

isInside()

virtual bool isInside ( const realx3 &  point ) const

pure virtual

Implemented in PeakableRegion< RegionType >.

peek()

virtual realx3 peek ( ) const

pure virtual

Implemented in PeakableRegion< RegionType >.

read()

virtual bool read ( const dictionary &  dict )

pure virtual

Implemented in PeakableRegion< RegionType >.

write()

virtual bool write ( dictionary &  dict ) const

pure virtual

Implemented in PeakableRegion< RegionType >.

create()

pFlow::uniquePtr< pFlow::peakableRegion > create ( const word &  type, const dictionary &  dict  )

static

Definition at line 36 of file peakableRegion.cpp.

References pFlow::angleBracketsNames(), fatalError, fatalExit, and pFlow::printKeys().

Here is the call graph for this function:

---

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

• src/phasicFlow/structuredData/peakableRegion/peakableRegion/peakableRegion.hpp
• src/phasicFlow/structuredData/peakableRegion/peakableRegion/peakableRegion.cpp