# PhasicFlow: pointField< VectorField, T, MemorySpace > Class Template Reference

pointField< VectorField, T, MemorySpace > Class Template Reference
Inheritance diagram for pointField< VectorField, T, MemorySpace >:
[legend]
Collaboration diagram for pointField< VectorField, T, MemorySpace >:
[legend]

## Public Types

using | pointFieldType = pointField< VectorField, T, MemorySpace >
using | FieldType = Field< VectorField, T, MemorySpace >
using | VectorType = typename FieldType::VectorType
using | iterator = typename FieldType::iterator
using | constIterator = typename FieldType::constIterator
using | reference = typename FieldType::reference
using | constReference = typename FieldType::constReference
using | valueType = typename FieldType::valueType
using | pointer = typename FieldType::pointer
using | constPointer = typename FieldType::constPointer
Public Types inherited from Field< VectorField, T, void >
using | VectorType = VectorField< T, void >
using | FieldType = Field< VectorField, T, void >
using | iterator = typename VectorType::iterator
using | constIterator = typename VectorType::constIterator
using | reference = typename VectorType::reference
using | constReference = typename VectorType::constReference
using | valueType = typename VectorType::valueType
using | pointer = typename VectorType::pointer
using | constPointer = typename VectorType::constPointer

## Public Member Functions

| TypeInfoTemplateNV2 ("pointField", T, VectorType::memoerySpaceName())
| pointField (const pointStructure &pStruct, const T &defVal, bool subscribe=true)
| pointField (const pointStructure &pStruct, const T &val, const T &defVal, bool subscribe=true)
| pointField (const pointField &src, bool subscribe)
| pointField (const pointField &src)
| pointField (pointField &&src)=delete
pointField & | operator= (const pointField &rhs)
pointField & | operator= (pointField &&)=delete
uniquePtr< pointFieldType > | clone () const
pointFieldType * | clonePtr () const
const pointStructure & | pStruct () const
INLINE_FUNCTION_H bool | allActive () const
INLINE_FUNCTION_H bool | isActive (label i) const
const auto & | pointFlag () const
range | activeRange () const
bool | update (const eventMessage &msg)
bool | readPointField (iIstream &is)
bool | writePointField (iOstream &os) const
bool | read (iIstream &is)
bool | write (iOstream &os) const
Public Member Functions inherited from eventObserver
| eventObserver ()
| eventObserver (const eventSubscriber &subscriber, bool subscribe=true)
virtual | ~eventObserver ()
bool | subscribed () const
bool | subscribe (const eventSubscriber &subscriber)
void | invalidateSubscriber ()
Public Member Functions inherited from Field< VectorField, T, void >
| TypeInfoTemplateNV2 ("Field", T, VectorType::memoerySpaceName())
| Field ()
| Field (const word &fieldKey)
| Field (const word &name, const word &fieldKey)
| Field (size_t len)
| Field (const word &fieldKey, size_t len)
| Field (const word &name, const word &fieldKey, size_t len)
| Field (size_t len, const T &val)
| Field (const word &fieldKey, size_t len, const T &val)
| Field (const word &name, const word &fieldKey, size_t len, const T &val)
| Field (size_t capacity, size_t len, RESERVE)
| Field (const word &fieldKey, size_t capacity, size_t len, RESERVE)
| Field (const word &name, const word &fieldKey, size_t capacity, size_t len, RESERVE)
| Field (const Vector< T > &vec)
| Field (const word &fieldKey, const Vector< T > &vec)
| Field (const word &name, const word &fieldKey, const Vector< T > &vec)
| Field (const word &name, const word &fieldKey, const FieldType &src)
| Field (const FieldType &)=default
| Field (FieldType &&)=delete
FieldType & | operator= (const FieldType &)=default
FieldType & | operator= (FieldType &&)=delete
INLINE_FUNCTION_H uniquePtr< FieldType > | clone () const
INLINE_FUNCTION_H FieldType * | clonePtr () const
const word & | fieldKey () const
bool | readField (iIstream &is, const size_t len, bool readLength=true)
bool | readField (iIstream &is)
bool | writeField (iOstream &os) const
bool | read (iIstream &is)
bool | write (iOstream &os) const

## Protected Attributes

const pointStructure & | pStruct_
T | defaultValue_
Protected Attributes inherited from eventObserver
const eventSubscriber * | subscriber_ = nullptr
bool | subscribed_ = false
Protected Attributes inherited from Field< VectorField, T, void >
const word | fieldKey_

## Additional Inherited Members

Protected Member Functions inherited from Field< VectorField, T, void >
bool | readUniform (iIstream &is, size_t len, bool readLength=true)
bool | readNonUniform (iIstream &is, size_t len)
Static Protected Attributes inherited from Field< VectorField, T, void >
static const word | FKey

## Detailed Description

### template<template< class, class > class VectorField, class T, class MemorySpace = void>
class pFlow::pointField< VectorField, T, MemorySpace >

Definition at line 35 of file pointField.hpp.

## Member Typedef Documentation

## pointFieldType

using pointFieldType = pointField<VectorField, T, MemorySpace>

Definition at line 42 of file pointField.hpp.

## FieldType

using FieldType = Field<VectorField, T, MemorySpace>

Definition at line 44 of file pointField.hpp.

## VectorType

using VectorType = typename FieldType::VectorType

Definition at line 46 of file pointField.hpp.

## iterator

using iterator = typename FieldType::iterator

Definition at line 48 of file pointField.hpp.

## constIterator

using constIterator = typename FieldType::constIterator

Definition at line 50 of file pointField.hpp.

## reference

using reference = typename FieldType::reference

Definition at line 52 of file pointField.hpp.

## constReference

using constReference = typename FieldType::constReference

Definition at line 54 of file pointField.hpp.

## valueType

using valueType = typename FieldType::valueType

Definition at line 56 of file pointField.hpp.

## pointer

using pointer = typename FieldType::pointer

Definition at line 58 of file pointField.hpp.

## constPointer

using constPointer = typename FieldType::constPointer

Definition at line 60 of file pointField.hpp.

## Constructor & Destructor Documentation

## pointField() [1/5]

pointField | ( | const pointStructure & | pStruct,
|  | const T & | defVal,
|  | bool | subscribe = `true`
| ) |  |

Definition at line 45 of file pointField.cpp.

## pointField() [2/5]

pointField | ( | const pointStructure & | pStruct,
|  | const T & | val,
|  | const T & | defVal,
|  | bool | subscribe = `true`
| ) |  |

Definition at line 62 of file pointField.cpp.

## pointField() [3/5]

pointField | ( | const pointField< VectorField, T, MemorySpace > & | src,
|  | bool | subscribe
| ) |  |

Definition at line 79 of file pointField.cpp.

## pointField() [4/5]

pointField | ( | const pointField< VectorField, T, MemorySpace > & | src | ) |

Definition at line 91 of file pointField.cpp.

## pointField() [5/5]

pointField | ( | pointField< VectorField, T, MemorySpace > && | src | ) |

delete

## Member Function Documentation

## TypeInfoTemplateNV2()

TypeInfoTemplateNV2 | ( | "pointField< VectorField, T, MemorySpace >" | ,
|  | T | ,
|  | VectorType::memoerySpaceName() |
| ) |  |

## operator=() [1/2]

pFlow::pointField< VectorField, T, MemorySpace > & operator= | ( | const pointField< VectorField, T, MemorySpace > & | rhs | ) |

Definition at line 99 of file pointField.cpp.

## operator=() [2/2]

pointField& operator= | ( | pointField< VectorField, T, MemorySpace > && |  | ) |

delete

## clone()

uniquePtr<pointFieldType> clone | ( |  | ) | const

inline

Definition at line 104 of file pointField.hpp.

## clonePtr()

pointFieldType* clonePtr | ( |  | ) | const

inline

Definition at line 109 of file pointField.hpp.

## pStruct()

const pointStructure& pStruct | ( |  | ) | const

inline

Definition at line 117 of file pointField.hpp.

## allActive()

INLINE_FUNCTION_H bool allActive | ( |  | ) | const

inline

Definition at line 123 of file pointField.hpp.

Referenced by pFlow::maxActive().

Here is the caller graph for this function:

## isActive()

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

inline

Definition at line 129 of file pointField.hpp.

## pointFlag()

const auto& pointFlag | ( |  | ) | const

inline

Definition at line 133 of file pointField.hpp.

Referenced by pFlow::maxActive().

Here is the caller graph for this function:

## activeRange()

range activeRange | ( |  | ) | const

inline

Definition at line 138 of file pointField.hpp.

Referenced by AdamsBashforth2::intRange(), AdamsBashforth3::intRange(), AdamsBashforth5::intRange(), AdamsBashforth4::intRange(), AdamsMoulton3::predictRange(), AdamsMoulton4::predictRange(), and AdamsMoulton5::predictRange().

Here is the caller graph for this function:

## update()

bool update | ( | const eventMessage & | msg | ) |

virtual

Implements eventObserver.

Definition at line 111 of file pointField.cpp.

## readPointField()

bool readPointField | ( | iIstream & | is | ) |

Definition at line 24 of file pointField.cpp.

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

Here is the caller graph for this function:

## writePointField()

bool writePointField | ( | iOstream & | os | ) | const

Definition at line 34 of file pointField.cpp.

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

Here is the caller graph for this function:

## read()

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

inline

Definition at line 154 of file pointField.hpp.

Referenced by pFlow::operator>>().

Here is the caller graph for this function:

## write()

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

inline

Definition at line 159 of file pointField.hpp.

Referenced by pFlow::operator<<().

Here is the caller graph for this function:

## Member Data Documentation

## pStruct_

const pointStructure& pStruct_

protected

Definition at line 65 of file pointField.hpp.

Referenced by pointField< T >::activeRange(), pointField< T >::allActive(), pointField< T >::isActive(), pointField< T >::pointFlag(), and pointField< T >::pStruct().

## defaultValue_

T defaultValue_

protected

Definition at line 68 of file pointField.hpp.

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

- src/phasicFlow/containers/pointField/pointField.hpp
- src/phasicFlow/containers/pointField/pointField.cpp