phasePropertiesList Class Reference

Simple container for a list of phase properties. More...

Collaboration diagram for phasePropertiesList:

Public Member Functions
	phasePropertiesList ()
	Construct null. More...
	phasePropertiesList (Istream &is, const wordList &gasNames, const wordList &liquidNames, const wordList &solidNames)
	Construct from components. More...
	~phasePropertiesList ()
	Destructor. More...
const List< phaseProperties > &	props () const
	Return the list of phase properties. More...
const wordList &	phaseTypes () const
	Return the list of word representation of phase types. More...
const wordList &	stateLabels () const
	Return the list of state labels. More...
label	size () const
	Return the size (number of phases) More...
const phaseProperties &	operator[] (const label) const

Private Attributes
List< phaseProperties >	props_
	List of phase properties. More...
wordList	phaseTypeNames_
	List of word representation of phase types. More...
wordList	stateLabels_
	List of state labels. More...

Detailed Description

Simple container for a list of phase properties.

Source files

• phasePropertiesList.H
• phasePropertiesList.C

Definition at line 51 of file phasePropertiesList.H.

Constructor & Destructor Documentation

phasePropertiesList() [1/2]

phasePropertiesList

(

)

Construct null.

Definition at line 30 of file phasePropertiesList.C.

phasePropertiesList() [2/2]

phasePropertiesList	(	Istream &	is,
		const wordList &	gasNames,
		const wordList &	liquidNames,
		const wordList &	solidNames
	)

Construct from components.

Definition at line 39 of file phasePropertiesList.C.

References forAll.

~phasePropertiesList()

~phasePropertiesList

(

)

Destructor.

Definition at line 67 of file phasePropertiesList.C.

Member Function Documentation

props()

const Foam::List< Foam::phaseProperties > & props

(

)

const

Return the list of phase properties.

Definition at line 74 of file phasePropertiesList.C.

phaseTypes()

const Foam::wordList & phaseTypes

(

)

const

Return the list of word representation of phase types.

Definition at line 80 of file phasePropertiesList.C.

stateLabels()

const Foam::wordList & stateLabels

(

)

const

Return the list of state labels.

Definition at line 86 of file phasePropertiesList.C.

size()

Foam::label size

(

)

const

Return the size (number of phases)

Definition at line 92 of file phasePropertiesList.C.

operator[]()

const Foam::phaseProperties & operator[]

(

const label

phaseI

)

const

Definition at line 99 of file phasePropertiesList.C.

Field Documentation

props_

List<phaseProperties> props_

private

List of phase properties.

Definition at line 56 of file phasePropertiesList.H.

phaseTypeNames_

wordList phaseTypeNames_

private

List of word representation of phase types.

Definition at line 59 of file phasePropertiesList.H.

stateLabels_

wordList stateLabels_

private

List of state labels.

Definition at line 62 of file phasePropertiesList.H.

---

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

• src/lagrangian/intermediate/phaseProperties/phasePropertiesList/phasePropertiesList.H
• src/lagrangian/intermediate/phaseProperties/phasePropertiesList/phasePropertiesList.C