Class to create, store and output qgraph files. More...


Classes | |
| class | writer |
| Abstract base class for a graph writer. More... | |
Public Member Functions | |
| graph (const string &title, const string &xName, const string &yName, const scalarField &x) | |
| Construct from title and labels (no curves) More... | |
| graph (const string &title, const string &xName, const string &yName, const scalarField &x, const scalarField &y) | |
| Construct from title, labels and y data for 1 curve. More... | |
| graph (const string &title, const string &xName, const string &yName, Istream &is) | |
| Construct from Istream given title and labels. More... | |
| graph (Istream &is) | |
| Construct from Istream. More... | |
| const string & | title () const |
| const string & | xName () const |
| const string & | yName () const |
| const scalarField & | x () const |
| scalarField & | x () |
| const scalarField & | y () const |
| scalarField & | y () |
| void | setXRange (const scalar x0, const scalar x1) |
| void | writeTable (Ostream &) const |
| Write out graph data as a simple table. More... | |
| void | write (Ostream &, const word &format) const |
| Write graph to stream in given format. More... | |
| void | write (const fileName &pName, const word &format) const |
| Write graph to file in given path-name and format. More... | |
| void | write (const fileName &path, const word &name, const word &format) const |
| Write graph to file in given path, name and format. More... | |
Public Member Functions inherited from HashPtrTable< curve > | |
| HashPtrTable ()=default | |
| Default construct with default table capacity. More... | |
| HashPtrTable (const label size) | |
| Construct given initial table capacity. More... | |
| HashPtrTable (const this_type &rhs) | |
| Copy construct, making a copy of each element. More... | |
| HashPtrTable (this_type &&rhs) | |
| Move construct. More... | |
| HashPtrTable (Istream &is, const INew &inew) | |
| Construct from Istream using given Istream constructor class. More... | |
| HashPtrTable (Istream &is) | |
| Construct from Istream using default Istream constructor class. More... | |
| HashPtrTable (const dictionary &dict) | |
| Construct from dictionary with default dictionary constructor class. More... | |
| ~HashPtrTable () | |
| Destructor. More... | |
| const curve * | test (const word &key) const |
| Return const pointer associated with given entry or a nullptr if the key does not exist in the table. More... | |
| const curve * | get (const word &key) const |
| Return const pointer associated with given entry or a nullptr if the key does not exist in the table. More... | |
| autoPtr< curve > | release (iterator &iter) |
| Release ownership of the pointer and replace with a nullptr. More... | |
| autoPtr< curve > | release (const word &key) |
| Release ownership of the pointer and replace with a nullptr. More... | |
| autoPtr< curve > | remove (iterator &iter) |
| Remove entry specified by given iterator. More... | |
| autoPtr< curve > | remove (const word &key) |
| Remove entry specified by given key. More... | |
| bool | erase (iterator &iter) |
| Erase entry specified by given iterator and delete the allocated pointer. More... | |
| bool | erase (const word &key) |
| Erase entry specified by given key and delete the allocated pointer. More... | |
| void | clear () |
| Clear all entries from table and delete any allocated pointers. More... | |
| void | merge (HashPtrTable< curve, word, Foam::Hash< word > > &source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More... | |
| void | merge (HashPtrTable< curve, word, Foam::Hash< word > > &&source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More... | |
| void | write (Ostream &os) const |
| Invoke write() on each non-null entry. More... | |
| void | operator= (const this_type &rhs) |
| Copy assignment. More... | |
| void | operator= (this_type &&rhs) |
| Move assignment. More... | |
| bool | emplace (const word &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. More... | |
| curve & | emplace_set (const word &key, Args &&... args) |
| Emplace set an entry, overwriting any existing entries. More... | |
| bool | insert (const word &, curve *)=delete |
| No insert() with raw pointers (potential memory leaks). Use insert() with autoPtr or set() More... | |
| bool | insert (const word &key, std::unique_ptr< curve > &&ptr) |
| Insert a new entry, not overwriting existing entries. More... | |
| bool | insert (const word &key, autoPtr< curve > &&ptr) |
| Insert a new entry, not overwriting existing entries. More... | |
| bool | insert (const word &key, autoPtr< curve > &ptr) |
| Insert a new entry, not overwriting existing entries. More... | |
| bool | set (const word &key, curve *ptr) |
| Assign a new entry, overwrites existing. More... | |
| bool | set (const word &key, std::unique_ptr< curve > &&ptr) |
| Assign a new entry, overwrites existing. More... | |
| bool | set (const word &key, autoPtr< curve > &&ptr) |
| Assign a new entry, overwrites existing. More... | |
| bool | set (const word &key, const refPtr< curve > &ptr) |
| Assign a new entry from refPtr (move or clone), overwrites existing. More... | |
| bool | set (const word &key, const tmp< curve > &ptr) |
| Assign a new entry from tmp (move or clone), overwrites existing. More... | |
| bool | set (const word &key, autoPtr< curve > &ptr) |
| Assign a new entry, overwrites existing. More... | |
Public Member Functions inherited from HashTable< T, Key, Hash > | |
| HashTable () | |
| Default construct with default (128) table capacity. More... | |
| HashTable (const label size) | |
| Construct given initial table capacity. More... | |
| HashTable (Istream &is, const label size=128) | |
| Construct from Istream with default table capacity. More... | |
| HashTable (const this_type &ht) | |
| Copy construct. More... | |
| HashTable (this_type &&rhs) | |
| Move construct. More... | |
| HashTable (std::initializer_list< std::pair< Key, T >> list) | |
| Construct from an initializer list. More... | |
| ~HashTable () | |
| Destructor. More... | |
| bool | empty () const noexcept |
| True if the hash table is empty. More... | |
| label | size () const noexcept |
| The number of elements in table. More... | |
| label | capacity () const noexcept |
| The size of the underlying table. More... | |
| T & | at (const Key &key) |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| const T & | at (const Key &key) const |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| bool | contains (const Key &key) const |
| True if hashed key is contained (found) in table. More... | |
| iterator | find (const Key &key) |
| Find and return an iterator set at the hashed entry. More... | |
| const_iterator | find (const Key &key) const |
| Find and return an const_iterator set at the hashed entry. More... | |
| const_iterator | cfind (const Key &key) const |
| Find and return an const_iterator set at the hashed entry. More... | |
| const T & | lookup (const Key &key, const T &deflt) const |
| Return hashed entry if it exists, or return the given default. More... | |
| List< Key > | toc () const |
| The table of contents (the keys) in unsorted order. More... | |
| List< Key > | sortedToc () const |
| The table of contents (the keys) in sorted order. More... | |
| template<class Compare > | |
| List< Key > | sortedToc (const Compare &comp) const |
| The table of contents (the keys) sorted according to the specified comparator. More... | |
| template<class UnaryPredicate > | |
| List< Key > | tocKeys (const UnaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the unary predicate applied to the keys. More... | |
| template<class UnaryPredicate > | |
| List< Key > | tocValues (const UnaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the unary predicate applied to the values. More... | |
| template<class BinaryPredicate > | |
| List< Key > | tocEntries (const BinaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the binary predicate applied to the keys and values. More... | |
| UPtrList< const node_type > | csorted () const |
| Const access to the hash-table contents in sorted order (sorted by keys). More... | |
| UPtrList< const node_type > | sorted () const |
| Const access to the hash-table contents in sorted order (sorted by keys). More... | |
| UPtrList< node_type > | sorted () |
| Non-const access to the hash-table contents in sorted order (sorted by keys). More... | |
| template<class UnaryPredicate > | |
| label | countKeys (const UnaryPredicate &pred, const bool invert=false) const |
| Count the number of keys that satisfy the unary predicate. More... | |
| template<class UnaryPredicate > | |
| label | countValues (const UnaryPredicate &pred, const bool invert=false) const |
| Count the number of values that satisfy the unary predicate. More... | |
| template<class BinaryPredicate > | |
| label | countEntries (const BinaryPredicate &pred, const bool invert=false) const |
| Count the number of entries that satisfy the binary predicate. More... | |
| template<class... Args> | |
| bool | emplace (const Key &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. More... | |
| template<class... Args> | |
| bool | emplace_set (const Key &key, Args &&... args) |
| Emplace set an entry, overwriting any existing entries. More... | |
| bool | insert (const Key &key, const T &obj) |
| Copy insert a new entry, not overwriting existing entries. More... | |
| bool | insert (const Key &key, T &&obj) |
| Move insert a new entry, not overwriting existing entries. More... | |
| bool | set (const Key &key, const T &obj) |
| Copy assign a new entry, overwriting existing entries. More... | |
| bool | set (const Key &key, T &&obj) |
| Move assign a new entry, overwriting existing entries. More... | |
| bool | erase (const iterator &iter) |
| Erase an entry specified by given iterator. More... | |
| bool | erase (const Key &key) |
| Erase an entry specified by the given key. More... | |
| template<class AnyType , class AnyHash > | |
| label | erase (const HashTable< AnyType, Key, AnyHash > &other) |
| Remove table entries given by keys of the other hash-table. More... | |
| label | erase (std::initializer_list< Key > keys) |
| Remove table entries given by the listed keys. More... | |
| template<class InputIter > | |
| label | erase (InputIter first, InputIter last) |
| Remove multiple entries using an iterator range of keys. More... | |
| template<unsigned N> | |
| label | erase (const FixedList< Key, N > &keys) |
| Remove table entries given by the listed keys. More... | |
| label | erase (const UList< Key > &keys) |
| Remove table entries given by the listed keys. More... | |
| template<class AnyType , class AnyHash > | |
| label | retain (const HashTable< AnyType, Key, AnyHash > &other) |
| Retain table entries given by keys of the other hash-table. More... | |
| template<class UnaryPredicate > | |
| label | filterKeys (const UnaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their keys. More... | |
| template<class UnaryPredicate > | |
| label | filterValues (const UnaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their values. More... | |
| template<class BinaryPredicate > | |
| label | filterEntries (const BinaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their key/value. More... | |
| void | resize (const label sz) |
| Resize the hash table for efficiency. More... | |
| void | clear () |
| Clear all entries from table. More... | |
| void | clearStorage () |
| Clear the table entries and the table itself. More... | |
| void | swap (HashTable< T, Key, Hash > &rhs) |
| Swap contents into this table. More... | |
| void | transfer (HashTable< T, Key, Hash > &rhs) |
| Transfer contents into this table. More... | |
| void | merge (HashTable< T, Key, Hash > &source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More... | |
| void | merge (HashTable< T, Key, Hash > &&source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More... | |
| T & | operator[] (const Key &key) |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| const T & | operator[] (const Key &key) const |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| T & | operator() (const Key &key) |
| Return existing entry or create a new entry. More... | |
| T & | operator() (const Key &key, const T &deflt) |
| Return existing entry or insert a new entry. More... | |
| void | operator= (const this_type &rhs) |
| Copy assign. More... | |
| void | operator= (std::initializer_list< std::pair< Key, T >> rhs) |
| Copy assign from an initializer list. More... | |
| void | operator= (this_type &&rhs) |
| Move assign. More... | |
| bool | operator== (const this_type &rhs) const |
| Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. More... | |
| bool | operator!= (const this_type &rhs) const |
| The opposite of the equality operation. More... | |
| this_type & | operator+= (const this_type &rhs) |
| Add entries into this HashTable. More... | |
| const_iterator_pair< const_key_iterator, this_type > | keys () const |
| A const iterator begin/end pair for iterating over keys. More... | |
| iterator | begin () |
| iterator set to the beginning of the HashTable More... | |
| const_iterator | begin () const |
| const_iterator set to the beginning of the HashTable More... | |
| const_iterator | cbegin () const |
| const_iterator set to the beginning of the HashTable More... | |
| iterator | end () noexcept |
| iterator to signal the end (for any HashTable) More... | |
| const_iterator | end () const noexcept |
| const_iterator to signal the end (for any HashTable) More... | |
| constexpr const_iterator | cend () const noexcept |
| const_iterator to signal the end (for any HashTable) More... | |
| Ostream & | printInfo (Ostream &os) const |
| Print information. More... | |
| Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
| Write unordered keys (list), with line-breaks when length exceeds shortLen. More... | |
| bool | found (const Key &key) const |
| Same as contains() More... | |
| template<class Compare > | |
| Foam::List< Key > | sortedToc (const Compare &comp) const |
| template<class UnaryPredicate > | |
| Foam::List< Key > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
| template<class UnaryPredicate > | |
| Foam::List< Key > | tocValues (const UnaryPredicate &pred, const bool invert) const |
| template<class BinaryPredicate > | |
| Foam::List< Key > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
| template<class UnaryPredicate > | |
| Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
| template<class UnaryPredicate > | |
| Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
| template<class BinaryPredicate > | |
| Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
| template<class InputIter> | |
| Foam::label | erase (InputIter first, InputIter last) |
| template<unsigned N> | |
| Foam::label | erase (const FixedList< Key, N > &keys) |
| template<class AnyType, class AnyHash > | |
| Foam::label | erase (const HashTable< AnyType, Key, AnyHash > &other) |
| template<class AnyType , class AnyHash > | |
| Foam::label | retain (const HashTable< AnyType, Key, AnyHash > &other) |
| template<class UnaryPredicate > | |
| Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
| template<class UnaryPredicate > | |
| Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
| template<class BinaryPredicate > | |
| Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
Public Member Functions inherited from HashTableCore | |
| ClassName ("HashTable") | |
| Declare type-name (with debug switch) More... | |
| HashTableCore () noexcept=default | |
| Default construct. More... | |
Static Public Member Functions | |
| static word | wordify (const string &sname) |
| Helper function to convert string name into appropriate word. More... | |
Static Public Member Functions inherited from HashTableCore | |
| static label | canonicalSize (const label requested_size) |
| Return a canonical (power-of-two) of the requested size. More... | |
Friends | |
| Ostream & | operator<< (Ostream &, const graph &) |
| Ostream Operator. More... | |
Additional Inherited Members | |
Public Types inherited from HashPtrTable< curve > | |
| typedef HashPtrTable< curve, word, Foam::Hash< word > > | this_type |
| The template instance used for this table. More... | |
| typedef HashTable< curve *, word, Foam::Hash< word > > | parent_type |
| The template instance used for the parent HashTable. More... | |
| using | iterator = typename parent_type::iterator |
| using | const_iterator = typename parent_type::const_iterator |
Public Types inherited from HashTable< T, Key, Hash > | |
| typedef HashTable< T, Key, Hash > | this_type |
| The template instance used for this HashTable. More... | |
| typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< T >::type >::value, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, T > >::type | node_type |
| A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More... | |
| typedef Key | key_type |
| The second template parameter, type of keys used. More... | |
| typedef T | mapped_type |
| The first template parameter, type of objects contained. More... | |
| typedef T | value_type |
| Same as mapped_type for OpenFOAM HashTables. More... | |
| typedef Hash | hasher |
| The third template parameter, the hash index method. More... | |
| typedef T * | pointer |
| Pointer type for storing into value_type objects. More... | |
| typedef T & | reference |
| Reference to the stored value_type. More... | |
| typedef const T * | const_pointer |
| Const pointer type for the stored value_type. More... | |
| typedef const T & | const_reference |
| Const reference to the stored value_type. More... | |
| typedef label | difference_type |
| The type to represent the difference between two iterators. More... | |
| typedef label | size_type |
| The type that can represent the size of a HashTable. More... | |
| using | key_iterator = key_iterator_base< iterator > |
| Forward iterator returning the key. More... | |
| using | const_key_iterator = key_iterator_base< const_iterator > |
| Forward const iterator returning the key. More... | |
Static Public Attributes inherited from HashTableCore | |
| static const label | maxTableSize |
| Maximum allowable internal table size. Approximately labelMax/4. More... | |
Class to create, store and output qgraph files.
| graph | ( | const string & | title, |
| const string & | xName, | ||
| const string & | yName, | ||
| const scalarField & | x | ||
| ) |
| graph | ( | const string & | title, |
| const string & | xName, | ||
| const string & | yName, | ||
| const scalarField & | x, | ||
| const scalarField & | y | ||
| ) |
Construct from title, labels and y data for 1 curve.
Definition at line 90 of file graph.C.
References curve::curveStyle::CONTINUOUS, and y.
|
inline |
Definition at line 165 of file graph.H.
Referenced by Foam::kShellIntegration(), and noiseFFT::PSD().

|
inline |
| const Foam::scalarField & y | ( | ) | const |
Definition at line 137 of file graph.C.
References stdFoam::begin(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.
Referenced by noiseFFT::PSD().


| Foam::scalarField & y | ( | ) |
Definition at line 150 of file graph.C.
References stdFoam::begin(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

| void setXRange | ( | const scalar | x0, |
| const scalar | x1 | ||
| ) |
Definition at line 163 of file graph.C.
References Foam::abort(), Foam::constant::universal::c, Foam::FatalError, FatalErrorInFunction, forAll, forAllIters, and Foam::nl.

| void writeTable | ( | Ostream & | os | ) | const |
Write out graph data as a simple table.
Definition at line 244 of file graph.C.
References Foam::endl(), forAll, forAllConstIters(), os(), Foam::setw(), and token::SPACE.

Write graph to stream in given format.
Definition at line 259 of file graph.C.
References format(), Foam::New(), os(), and Foam::vtk::write().
Referenced by Foam::makeGraph().


Write graph to file in given path-name and format.
Definition at line 265 of file graph.C.
References Foam::endl(), format(), IOstream::good(), OFstream::name(), Foam::New(), WarningInFunction, Foam::vtk::write(), and writer().

Write graph to file in given path, name and format.
Definition at line 285 of file graph.C.
References format(), Foam::mkDir(), Foam::name(), path(), and Foam::vtk::write().

|
static |
Helper function to convert string name into appropriate word.
Definition at line 40 of file graph.C.
References string::replace().

Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.