graph Class Reference

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

Inheritance diagram for graph:
[legend]
Collaboration diagram for graph:
[legend]

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 stringtitle () const
 
const stringxName () const
 
const stringyName () const
 
const scalarFieldx () const
 
scalarFieldx ()
 
const scalarFieldy () const
 
scalarFieldy ()
 
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 (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 (const this_type &rhs)
 Copy construct, making a copy of each element. More...
 
 HashPtrTable (this_type &&rhs)
 Move construct. More...
 
 ~HashPtrTable ()
 Destructor. More...
 
const curveget (const word &key) const
 
autoPtr< curverelease (iterator &iter)
 Release ownership of the pointer and replace with a nullptr. More...
 
autoPtr< curverelease (const word &key)
 Release ownership of the pointer and replace with a nullptr. More...
 
autoPtr< curveremove (iterator &iter)
 Remove entry specified by given iterator. More...
 
autoPtr< curveremove (const word &key)
 Remove entry specified by given key. More...
 
bool erase (iterator &iter)
 
bool erase (const word &key)
 
void clear ()
 Clear all entries from table and delete any allocated pointers. 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...
 
bool emplace_set (const word &key, Args &&... args)
 Emplace set an entry, overwriting any existing entries. More...
 
bool insert (const word &, curve *)=delete
 
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 insert (const word &key, std::unique_ptr< curve > &&ptr)
 Insert a new entry, not overwriting existing entries. More...
 
bool set (const word &key, curve *ptr)
 Assign a new entry, overwriting existing entries. More...
 
bool set (const word &key, autoPtr< curve > &ptr)
 Assign a new entry, overwriting existing entries. More...
 
bool set (const word &key, autoPtr< curve > &&ptr)
 Assign a new entry, overwriting existing entries. More...
 
bool set (const word &key, std::unique_ptr< curve > &&ptr)
 Assign a new entry, overwriting existing entries. 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...
 
label capacity () const noexcept
 The size of the underlying table. More...
 
label size () const noexcept
 The number of elements in table. More...
 
bool empty () const noexcept
 True if the hash table is empty. More...
 
Tat (const Key &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const Tat (const Key &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
bool found (const Key &key) const
 Return true if hashed entry is 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 Tlookup (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
 
template<class UnaryPredicate >
List< Key > tocKeys (const UnaryPredicate &pred, const bool invert=false) const
 
template<class UnaryPredicate >
List< Key > tocValues (const UnaryPredicate &pred, const bool invert=false) const
 
template<class BinaryPredicate >
List< Key > tocEntries (const BinaryPredicate &pred, const bool invert=false) const
 
UPtrList< const node_typecsorted () const
 
UPtrList< const node_typesorted () const
 
UPtrList< node_typesorted ()
 
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...
 
Toperator[] (const Key &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const Toperator[] (const Key &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
Toperator() (const Key &key)
 Return existing entry or create a new entry. More...
 
Toperator() (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
 
bool operator!= (const this_type &rhs) const
 The opposite of the equality operation. More...
 
this_typeoperator+= (const this_type &rhs)
 Add entries into this HashTable. More...
 
const_iterator_pair< const_key_iterator, this_typekeys () 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...
 
OstreamprintInfo (Ostream &os) const
 Print information. More...
 
OstreamwriteKeys (Ostream &os, const label shortLen=0) const
 
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 ()=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

Ostreamoperator<< (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, Hashthis_type
 The template instance used for this HashTable. More...
 
typedef std::conditional< std::is_same< zero::null, typenamestd::remove_cv< T >::type >::value, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, T > >::type node_type
 
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 Tpointer
 Pointer type for storing into value_type objects. More...
 
typedef Treference
 Reference to the stored value_type. More...
 
typedef const Tconst_pointer
 Const pointer type for the stored value_type. More...
 
typedef const Tconst_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...
 
- Protected Member Functions inherited from HashTable< T, Key, Hash >
bool iterator_erase (node_type *&entry, label &index)
 Low-level entry erasure using iterator internals. More...
 

Detailed Description

Class to create, store and output qgraph files.

Source files

Definition at line 59 of file graph.H.

Constructor & Destructor Documentation

◆ graph() [1/4]

graph ( const string title,
const string xName,
const string yName,
const scalarField x 
)

Construct from title and labels (no curves)

Definition at line 81 of file graph.C.

◆ graph() [2/4]

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 96 of file graph.C.

References curve::curveStyle::CONTINUOUS, HashPtrTable< curve >::set(), graph::wordify(), graph::y(), and graph::yName().

Here is the call graph for this function:

◆ graph() [3/4]

graph ( const string title,
const string xName,
const string yName,
Istream is 
)

Construct from Istream given title and labels.

Definition at line 118 of file graph.C.

◆ graph() [4/4]

graph ( Istream is)
explicit

Construct from Istream.

Definition at line 134 of file graph.C.

Member Function Documentation

◆ title()

const string & title ( ) const
inline

Definition at line 147 of file graph.H.

Referenced by surfaceNoise::calculate().

Here is the caller graph for this function:

◆ xName()

const string & xName ( ) const
inline

Definition at line 152 of file graph.H.

◆ yName()

const string & yName ( ) const
inline

Definition at line 157 of file graph.H.

Referenced by graph::graph().

Here is the caller graph for this function:

◆ x() [1/2]

const scalarField & x ( ) const
inline

Definition at line 163 of file graph.H.

Referenced by Foam::kShellIntegration(), and noiseFFT::PSD().

Here is the caller graph for this function:

◆ x() [2/2]

scalarField & x ( )
inline

Definition at line 168 of file graph.H.

◆ y() [1/2]

const Foam::scalarField & y ( ) const

Definition at line 144 of file graph.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Referenced by graph::graph(), and noiseFFT::PSD().

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

◆ y() [2/2]

Definition at line 157 of file graph.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ setXRange()

void setXRange ( const scalar  x0,
const scalar  x1 
)

Definition at line 170 of file graph.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, forAllIters, and Foam::nl.

Here is the call graph for this function:

◆ writeTable()

void writeTable ( Ostream os) const

Write out graph data as a simple table.

Definition at line 251 of file graph.C.

References Foam::endl(), forAll, forAllConstIters, os(), Foam::setw(), and token::SPACE.

Here is the call graph for this function:

◆ write() [1/3]

void write ( Ostream os,
const word format 
) const

Write graph to stream in given format.

Definition at line 266 of file graph.C.

References format(), os(), and write().

Referenced by surfaceNoise::calculate(), Foam::makeGraph(), Foam::writeCellGraph(), and Foam::writePatchGraph().

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

◆ write() [2/3]

void write ( const fileName pName,
const word format 
) const

Write graph to file in given path-name and format.

Definition at line 272 of file graph.C.

References Foam::endl(), format(), IOstream::good(), OFstream::name(), WarningInFunction, write(), and writer().

Here is the call graph for this function:

◆ write() [3/3]

void write ( const fileName path,
const word name,
const word format 
) const

Write graph to file in given path, name and format.

Definition at line 291 of file graph.C.

References format(), Foam::mkDir(), Foam::name(), path(), and write().

Here is the call graph for this function:

◆ wordify()

Foam::word wordify ( const string sname)
static

Helper function to convert string name into appropriate word.

Definition at line 47 of file graph.C.

References string::replace().

Referenced by surfaceNoise::calculate(), graph::graph(), and pointNoise::processData().

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

Friends And Related Function Documentation

◆ operator<<

Ostream & operator<< ( Ostream ,
const graph  
)
friend

Ostream Operator.


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