# PhasicFlow: pointStructure Class Reference

pointStructure Class Reference
Inheritance diagram for pointStructure:
[legend]
Collaboration diagram for pointStructure:
[legend]

## Classes

class | activePointsDevice
class | activePointsHost

## Public Types

enum | PointFlag : int8 { DELETED = -1, ACTIVE = 1 }

## Public Member Functions

| TypeInfo ("pointStructure")
| pointStructure ()
| pointStructure (const int8Vector &flgVec, const realx3Vector &posVec)
| pointStructure (const realx3Vector &posVec)
| pointStructure (const pointStructure &)=default
| pointStructure (pointStructure &&)=delete
pointStructure & | operator= (const pointStructure &)=default
pointStructure & | operator= (pointStructure &&)=delete
virtual | ~pointStructure ()=default
activePointsDevice | activePointsMaskD () const
activePointsHost | activePointsMaskH () const
const FUNCTION_H realx3Field_D & | pointPosition () const
const FUNCTION_H int8Field_HD & | pointFlag () const
INLINE_FUNCTION_H auto | pointPositionHostAll ()
FUNCTION_H label | size () const
FUNCTION_H label | capacity () const
FUNCTION_H label | numActive () const
FUNCTION_H bool | allActive () const
INLINE_FUNCTION_H range | activeRange () const
INLINE_FUNCTION_H bool | isActive (label i) const
FUNCTION_H size_t | markDeleteOutOfBox (const box &domain)
virtual FUNCTION_H bool | updateForDelete ()
FUNCTION_H auto | insertedPointIndex () const
FUNCTION_H auto | insertedPointIndexH () const
FUNCTION_H auto | insertedPointIndexD () const
virtual FUNCTION_H uniquePtr< int32IndexContainer > | insertPoints (const realx3Vector &pos, const setFieldList &setField, repository &owner, const List< eventObserver * > &exclusionList={nullptr})
FUNCTION_H bool | readPointStructure (iIstream &is)
FUNCTION_H bool | writePointStructure (iOstream &os) const
FUNCTION_H bool | read (iIstream &is)
FUNCTION_H bool | write (iOstream &os) const
Public Member Functions inherited from eventSubscriber
| eventSubscriber ()
virtual | ~eventSubscriber ()
virtual bool | subscribe (eventObserver *observer) const
virtual bool | unsubscribe (eventObserver *observer) const
bool | notify (const eventMessage &msg)
bool | notify (const eventMessage &msg, const List< eventObserver * > &exclutionList)

## Static Public Attributes

static const size_t | maxSizeDefault_ = 10000

## Protected Member Functions

FUNCTION_H bool | evaluatePointStructure ()
FUNCTION_H void | setNumMaxPoints ()
FUNCTION_H realx3Field_D & | pointPosition ()
FUNCTION_H int8Field_HD & | pointFlag ()
FUNCTION_H uniquePtr< int32IndexContainer > | getNewPointsIndices (int32 numNewPoints) const

## Protected Attributes

size_t | numPoints_ = 0
size_t | maxPoints_ = maxSizeDefault_
int8Field_HD | pointFlag_
realx3Field_D | pointPosition_
size_t | numActivePoints_ = 0
range | activeRange_
int32IndexContainer | tobeInsertedIndex_
Protected Attributes inherited from eventSubscriber
List< eventObserver * > | observerList_

## Friends

class | dynamicPointStructure

## Detailed Description

Definition at line 44 of file pointStructure.hpp.

## Member Enumeration Documentation

## PointFlag

enum PointFlag : int8

Enumerator
DELETED |
ACTIVE |

Definition at line 50 of file pointStructure.hpp.

## Constructor & Destructor Documentation

## pointStructure() [1/5]

pointStructure | ( |  | ) |

Definition at line 142 of file pointStructure.cpp.

## pointStructure() [2/5]

pointStructure | ( | const int8Vector & | flgVec,
|  | const realx3Vector & | posVec
| ) |  |

Definition at line 151 of file pointStructure.cpp.

References fatalExit.

## pointStructure() [3/5]

pointStructure | ( | const realx3Vector & | posVec | ) |

Definition at line 174 of file pointStructure.cpp.

References pointStructure::ACTIVE, and fatalExit.

## pointStructure() [4/5]

pointStructure | ( | const pointStructure & |  | ) |

default

## pointStructure() [5/5]

pointStructure | ( | pointStructure && |  | ) |

delete

## ~pointStructure()

virtual ~pointStructure | ( |  | ) |

virtualdefault

## Member Function Documentation

## evaluatePointStructure()

FUNCTION_H bool evaluatePointStructure | ( |  | ) |

protected

Definition at line 30 of file pointStructure.cpp.

References pointStructure::ACTIVE, pointStructure::activeRange_, VectorDual< T, MemorySpace >::deviceVectorAll(), fatalErrorInFunction, pFlow::maxActive(), pointStructure::numActivePoints_, pointStructure::numPoints_, pointStructure::pointFlag_, pointStructure::pointPosition_, pFlow::pointStructureKernels::scanPointFlag(), pointStructure::setNumMaxPoints(), VectorSingle< T, MemorySpace >::size(), and VectorDual< T, MemorySpace >::size().

Here is the call graph for this function:

## setNumMaxPoints()

FUNCTION_H void setNumMaxPoints | ( |  | ) |

protected

Definition at line 57 of file pointStructure.cpp.

Referenced by pointStructure::evaluatePointStructure().

Here is the caller graph for this function:

## pointPosition() [1/2]

const FUNCTION_H pFlow::realx3Field_D & pointPosition | ( |  | ) |

protected

Definition at line 64 of file pointStructure.cpp.

Referenced by pFlow::PFtoVTK::convertTimeFolderPointFields(), pFlow::PFtoVTK::convertTimeFolderPointFieldsSelected(), selectBox::selectAllPointsInBox(), and dynamicPointStructure::update().

Here is the caller graph for this function:

## pointFlag() [1/2]

const FUNCTION_H pFlow::int8Field_HD & pointFlag | ( |  | ) |

protected

Definition at line 70 of file pointStructure.cpp.

Referenced by pointField< T >::pointFlag().

Here is the caller graph for this function:

## getNewPointsIndices()

pFlow::uniquePtr< pFlow::int32IndexContainer > getNewPointsIndices | ( | int32 | numNewPoints | ) | const

protected

Definition at line 76 of file pointStructure.cpp.

References Vector< T, Allocator >::clear(), fatalErrorInFunction, and ForAll.

Here is the call graph for this function:

## TypeInfo()

TypeInfo | ( | "pointStructure" |  | ) |

## operator=() [1/2]

pointStructure& operator= | ( | const pointStructure & |  | ) |

default

## operator=() [2/2]

pointStructure& operator= | ( | pointStructure && |  | ) |

delete

## activePointsMaskD()

activePointsDevice activePointsMaskD | ( |  | ) | const

inline

Definition at line 232 of file pointStructure.hpp.

References pointStructure::activeRange(), pointStructure::allActive(), and VectorDual< T, MemorySpace >::deviceVectorAll().

Here is the call graph for this function:

## activePointsMaskH()

activePointsHost activePointsMaskH | ( |  | ) | const

inline

Definition at line 241 of file pointStructure.hpp.

References pointStructure::activeRange(), pointStructure::allActive(), and VectorDual< T, MemorySpace >::hostVectorAll().

Referenced by pointRectCell::mapPOints().

Here is the call graph for this function:
Here is the caller graph for this function:

## pointPosition() [2/2]

const FUNCTION_H realx3Field_D& pointPosition | ( |  | ) | const

## pointFlag() [2/2]

const FUNCTION_H int8Field_HD& pointFlag | ( |  | ) | const

## pointPositionHostAll()

INLINE_FUNCTION_H auto pointPositionHostAll | ( |  | ) |

inline

Definition at line 259 of file pointStructure.hpp.

References VectorSingle< T, MemorySpace >::hostVectorAll(), and pointStructure::pointPosition_.

Referenced by dynamicPointStructure::pointPositionHostAll().

Here is the call graph for this function:
Here is the caller graph for this function:

## size()

FUNCTION_H pFlow::label size | ( |  | ) | const

Definition at line 210 of file pointStructure.cpp.

## capacity()

FUNCTION_H pFlow::label capacity | ( |  | ) | const

Definition at line 216 of file pointStructure.cpp.

## numActive()

FUNCTION_H pFlow::label numActive | ( |  | ) | const

Definition at line 222 of file pointStructure.cpp.

## allActive()

FUNCTION_H bool allActive | ( |  | ) | const

Definition at line 228 of file pointStructure.cpp.

Referenced by pointStructure::activePointsMaskD(), pointStructure::activePointsMaskH(), and pointField< T >::allActive().

Here is the caller graph for this function:

## activeRange()

INLINE_FUNCTION_H range activeRange | ( |  | ) | const

inline

Definition at line 281 of file pointStructure.hpp.

References pointStructure::activeRange_.

Referenced by pointStructure::activePointsMaskD(), pointStructure::activePointsMaskH(), pointField< T >::activeRange(), and pointRectCell::mapPOints().

Here is the caller graph for this function:

## isActive()

INLINE_FUNCTION_H bool isActive | ( | label | i | ) | const

inline

Definition at line 287 of file pointStructure.hpp.

References pointStructure::ACTIVE, and pointStructure::pointFlag_.

Referenced by pointField< T >::isActive().

Here is the caller graph for this function:

## markDeleteOutOfBox()

FUNCTION_H size_t markDeleteOutOfBox | ( | const box & | domain | ) |

Definition at line 235 of file pointStructure.cpp.

References pointStructure::DELETED, fatalErrorInFunction, fatalExit, pFlow::pointStructureKernels::markDeleteOutOfBox(), and eventMessage::RANGE_CHANGED.

Referenced by dynamicPointStructure::markDeleteOutOfBox().

Here is the call graph for this function:
Here is the caller graph for this function:

## updateForDelete()

FUNCTION_H bool updateForDelete | ( |  | ) |

virtual

Definition at line 291 of file pointStructure.cpp.

References notImplementedFunction.

## insertedPointIndex()

FUNCTION_H auto insertedPointIndex | ( |  | ) | const

inline

Definition at line 305 of file pointStructure.hpp.

References pointStructure::tobeInsertedIndex_.

Referenced by dynamicPointStructure::update().

Here is the caller graph for this function:

## insertedPointIndexH()

FUNCTION_H auto insertedPointIndexH | ( |  | ) | const

inline

Definition at line 311 of file pointStructure.hpp.

References indexContainer< IndexType >::hostView(), and pointStructure::tobeInsertedIndex_.

Here is the call graph for this function:

## insertedPointIndexD()

FUNCTION_H auto insertedPointIndexD | ( |  | ) | const

inline

Definition at line 317 of file pointStructure.hpp.

References indexContainer< IndexType >::deviceView(), and pointStructure::tobeInsertedIndex_.

Here is the call graph for this function:

## insertPoints()

FUNCTION_H pFlow::uniquePtr< pFlow::int32IndexContainer > insertPoints | ( | const realx3Vector & | pos,
|  | const setFieldList & | setField,
|  | repository & | owner,
|  | const List< eventObserver * > & | exclusionList = `{nullptr}`
| ) |  |

virtual

Definition at line 300 of file pointStructure.cpp.

References eventMessage::add(), eventMessage::CAP_CHANGED, eventMessage::INSERT, pFlow::max(), pFlow::min(), eventMessage::RANGE_CHANGED, Vector< T, Allocator >::size(), and eventMessage::SIZE_CHANGED.

Here is the call graph for this function:

## readPointStructure()

FUNCTION_H bool readPointStructure | ( | iIstream & | is | ) |

Definition at line 389 of file pointStructure.cpp.

References ioErrorInFile, IOstream::lineNumber(), iIstream::lookupDataOrSet(), and IOstream::name().

Referenced by pointStructure::read().

Here is the call graph for this function:
Here is the caller graph for this function:

## writePointStructure()

FUNCTION_H bool writePointStructure | ( | iOstream & | os | ) | const

Definition at line 417 of file pointStructure.cpp.

References ioErrorInFile, IOstream::lineNumber(), IOstream::name(), and iOstream::writeWordEntry().

Referenced by pointStructure::write().

Here is the call graph for this function:
Here is the caller graph for this function:

## read()

FUNCTION_H bool read | ( | iIstream & | is | ) |

inline

Definition at line 347 of file pointStructure.hpp.

References pointStructure::readPointStructure().

Here is the call graph for this function:

## write()

FUNCTION_H bool write | ( | iOstream & | os | ) | const

inline

Definition at line 354 of file pointStructure.hpp.

References pointStructure::writePointStructure().

Here is the call graph for this function:

## Friends And Related Function Documentation

## dynamicPointStructure

friend class dynamicPointStructure

friend

Definition at line 191 of file pointStructure.hpp.

## Member Data Documentation

## maxSizeDefault_

const size_t maxSizeDefault_ = 10000

inlinestatic

Definition at line 57 of file pointStructure.hpp.

## numPoints_

size_t numPoints_ = 0

protected

Definition at line 149 of file pointStructure.hpp.

Referenced by pointStructure::evaluatePointStructure().

## maxPoints_

size_t maxPoints_ = maxSizeDefault_

protected

Definition at line 152 of file pointStructure.hpp.

## pointFlag_

int8Field_HD pointFlag_

protected

Definition at line 155 of file pointStructure.hpp.

Referenced by pointStructure::evaluatePointStructure(), and pointStructure::isActive().

## pointPosition_

realx3Field_D pointPosition_

protected

Definition at line 158 of file pointStructure.hpp.

Referenced by pointStructure::evaluatePointStructure(), and pointStructure::pointPositionHostAll().

## numActivePoints_

size_t numActivePoints_ = 0

protected

Definition at line 161 of file pointStructure.hpp.

Referenced by pointStructure::evaluatePointStructure().

## activeRange_

range activeRange_

protected

Definition at line 164 of file pointStructure.hpp.

Referenced by pointStructure::activeRange(), and pointStructure::evaluatePointStructure().

## tobeInsertedIndex_

int32IndexContainer tobeInsertedIndex_

protected

Definition at line 167 of file pointStructure.hpp.

Referenced by pointStructure::insertedPointIndex(), pointStructure::insertedPointIndexD(), and pointStructure::insertedPointIndexH().

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

- src/phasicFlow/structuredData/pointStructure/pointStructure.hpp
- src/phasicFlow/structuredData/pointStructure/pointStructure.cpp