Foam::fileOperations Namespace Reference

Namespace for implementations of a fileOperation. More...

Classes
class	collatedFileOperation
	Version of masterUncollatedFileOperation that collates regIOobjects into a container in the processors/ subdirectory. More...
class	dummyFileOperation
	Dummy fileOperation, to be used as a placeholder for interfaces taking a reference to a fileOperation. Will mostly behave like a no-op, but at the moment no guarantees of any particular behaviour other than good() returning false. More...
class	fileOperationInitialise
class	fileOperationInitialise_collated
	A fileOperation initialiser for collated file handlers. Requires threading for non-zero maxThreadFileBufferSize. More...
class	fileOperationInitialise_unthreaded
	A fileOperation initialiser for unthreaded file handlers. More...
class	hostCollatedFileOperation
	Version of collatedFileOperation with multiple read/write ranks. More...
class	hostUncollatedFileOperation
	Version of masterUncollated with host-based IO ranks. More...
class	masterUncollatedFileOperation
	fileOperations that performs all file operations on the master processor. Requires the calls to be parallel synchronised! More...
class	uncollatedFileOperation
	fileOperation that assumes file operations are local. More...

Functions
	defineTypeNameAndDebug (collatedFileOperation, 0)
	addToRunTimeSelectionTable (fileOperation, collatedFileOperation, word)
	addToRunTimeSelectionTable (fileOperation, collatedFileOperation, comm)
	registerOptSwitch ("maxThreadFileBufferSize", float, collatedFileOperation::maxThreadFileBufferSize)
	addNamedToRunTimeSelectionTable (fileOperationInitialise, fileOperationInitialise_collated, word, collated)
	defineTypeNameAndDebug (hostCollatedFileOperation, 0)
	addToRunTimeSelectionTable (fileOperation, hostCollatedFileOperation, word)
	addToRunTimeSelectionTable (fileOperation, hostCollatedFileOperation, comm)
	addNamedToRunTimeSelectionTable (fileOperationInitialise, fileOperationInitialise_collated, word, hostCollated)
	defineTypeName (dummyFileOperation)
	defineTypeNameAndDebug (fileOperationInitialise, 0)
	defineRunTimeSelectionTable (fileOperationInitialise, word)
	defineTypeNameAndDebug (masterUncollatedFileOperation, 0)
	addToRunTimeSelectionTable (fileOperation, masterUncollatedFileOperation, word)
	addToRunTimeSelectionTable (fileOperation, masterUncollatedFileOperation, comm)
	registerOptSwitch ("maxMasterFileBufferSize", float, masterUncollatedFileOperation::maxMasterFileBufferSize)
	addNamedToRunTimeSelectionTable (fileOperationInitialise, fileOperationInitialise_unthreaded, word, masterUncollated)
	defineTypeNameAndDebug (hostUncollatedFileOperation, 0)
	addToRunTimeSelectionTable (fileOperation, hostUncollatedFileOperation, word)
	addToRunTimeSelectionTable (fileOperation, hostUncollatedFileOperation, comm)
	addNamedToRunTimeSelectionTable (fileOperationInitialise, fileOperationInitialise_unthreaded, word, hostUncollated)
	defineTypeNameAndDebug (uncollatedFileOperation, 0)
	addToRunTimeSelectionTable (fileOperation, uncollatedFileOperation, word)
	addToRunTimeSelectionTable (fileOperation, uncollatedFileOperation, comm)
	addNamedToRunTimeSelectionTable (fileOperationInitialise, fileOperationInitialise_unthreaded, word, uncollated)

Detailed Description

Namespace for implementations of a fileOperation.

Function Documentation

defineTypeNameAndDebug() [1/6]

Foam::fileOperations::defineTypeNameAndDebug	(	collatedFileOperation	,
		0
	)

addToRunTimeSelectionTable() [1/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		collatedFileOperation	,
		word
	)

addToRunTimeSelectionTable() [2/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		collatedFileOperation	,
		comm
	)

registerOptSwitch() [1/2]

Foam::fileOperations::registerOptSwitch	(	"maxThreadFileBufferSize"	,
		float	,
		collatedFileOperation::maxThreadFileBufferSize
	)

addNamedToRunTimeSelectionTable() [1/5]

Foam::fileOperations::addNamedToRunTimeSelectionTable	(	fileOperationInitialise	,
		fileOperationInitialise_collated	,
		word	,
		collated
	)

defineTypeNameAndDebug() [2/6]

Foam::fileOperations::defineTypeNameAndDebug	(	hostCollatedFileOperation	,
		0
	)

addToRunTimeSelectionTable() [3/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		hostCollatedFileOperation	,
		word
	)

addToRunTimeSelectionTable() [4/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		hostCollatedFileOperation	,
		comm
	)

addNamedToRunTimeSelectionTable() [2/5]

Foam::fileOperations::addNamedToRunTimeSelectionTable	(	fileOperationInitialise	,
		fileOperationInitialise_collated	,
		word	,
		hostCollated
	)

defineTypeName()

Foam::fileOperations::defineTypeName

(

dummyFileOperation

)

defineTypeNameAndDebug() [3/6]

Foam::fileOperations::defineTypeNameAndDebug	(	fileOperationInitialise	,
		0
	)

defineRunTimeSelectionTable()

Foam::fileOperations::defineRunTimeSelectionTable	(	fileOperationInitialise	,
		word
	)

defineTypeNameAndDebug() [4/6]

Foam::fileOperations::defineTypeNameAndDebug	(	masterUncollatedFileOperation	,
		0
	)

addToRunTimeSelectionTable() [5/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		masterUncollatedFileOperation	,
		word
	)

addToRunTimeSelectionTable() [6/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		masterUncollatedFileOperation	,
		comm
	)

registerOptSwitch() [2/2]

Foam::fileOperations::registerOptSwitch	(	"maxMasterFileBufferSize"	,
		float	,
		masterUncollatedFileOperation::maxMasterFileBufferSize
	)

addNamedToRunTimeSelectionTable() [3/5]

Foam::fileOperations::addNamedToRunTimeSelectionTable	(	fileOperationInitialise	,
		fileOperationInitialise_unthreaded	,
		word	,
		masterUncollated
	)

defineTypeNameAndDebug() [5/6]

Foam::fileOperations::defineTypeNameAndDebug	(	hostUncollatedFileOperation	,
		0
	)

addToRunTimeSelectionTable() [7/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		hostUncollatedFileOperation	,
		word
	)

addToRunTimeSelectionTable() [8/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		hostUncollatedFileOperation	,
		comm
	)

addNamedToRunTimeSelectionTable() [4/5]

Foam::fileOperations::addNamedToRunTimeSelectionTable	(	fileOperationInitialise	,
		fileOperationInitialise_unthreaded	,
		word	,
		hostUncollated
	)

defineTypeNameAndDebug() [6/6]

Foam::fileOperations::defineTypeNameAndDebug	(	uncollatedFileOperation	,
		0
	)

addToRunTimeSelectionTable() [9/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		uncollatedFileOperation	,
		word
	)

addToRunTimeSelectionTable() [10/10]

Foam::fileOperations::addToRunTimeSelectionTable	(	fileOperation	,
		uncollatedFileOperation	,
		comm
	)

addNamedToRunTimeSelectionTable() [5/5]

Foam::fileOperations::addNamedToRunTimeSelectionTable	(	fileOperationInitialise	,
		fileOperationInitialise_unthreaded	,
		word	,
		uncollated
	)