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

Inheritance diagram for graph:

Collaboration diagram for graph:

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 (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 curve *	get (const word &key) const

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)

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...

Static Public Member Functions
static word	wordify (const string &sname)
	Helper function to convert string name into appropriate word. 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

Detailed Description

Class to create, store and output qgraph files.

Source files

Definition at line 61 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 83 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 98 of file graph.C.

References curve::curveStyle::CONTINUOUS, Foam::BitOps::set(), and y.

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

◆ graph() [4/4]

graph ( Istream & is )

Construct from Istream.

Definition at line 135 of file graph.C.

Member Function Documentation

◆ title()

const string& title ( ) const

inline

Definition at line 152 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 157 of file graph.H.

◆ yName()

const string& yName ( ) const

inline

Definition at line 162 of file graph.H.

◆ x() [1/2]

const scalarField& x ( ) const

inline

Definition at line 168 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 173 of file graph.H.

◆ y() [1/2]

const Foam::scalarField & y ( ) const

Definition at line 145 of file graph.C.

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

Referenced by noiseFFT::PSD().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ y() [2/2]

Foam::scalarField & y ( )

Definition at line 158 of file graph.C.

References stdFoam::begin(), 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 171 of file graph.C.

References Foam::abort(), Foam::constant::universal::c, 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 252 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 267 of file graph.C.

References format(), writer< Type >::New(), os(), and Foam::vtk::write().

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

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

References Foam::endl(), format(), IOstream::good(), OFstream::name(), writer< Type >::New(), WarningInFunction, and Foam::vtk::write().

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

References format(), Foam::mkDir(), Foam::name(), path(), and Foam::vtk::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 48 of file graph.C.

References string::replace().

Referenced by surfaceNoise::calculate(), 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:

src/OpenFOAM/graph/graph.H
src/OpenFOAM/graph/graph.C

Classes

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ graph() [1/4]

◆ graph() [2/4]

◆ graph() [3/4]

◆ graph() [4/4]

Member Function Documentation

◆ title()

◆ xName()

◆ yName()

◆ x() [1/2]

◆ x() [2/2]

◆ y() [1/2]

◆ y() [2/2]

◆ setXRange()

◆ writeTable()

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

◆ wordify()

Friends And Related Function Documentation

◆ operator<<