NeoFOAM::finiteVolume::cellCentred Namespace Reference

Namespaces
namespace	surfaceBoundary
namespace	volumeBoundary

Classes
class	BasicGeometryScheme
class	BoundaryPatchMixin
	A base class for implementing derived boundary conditions. More...
class	CreateFromExistingField
	Creates a FieldDocument from an existing field. More...
class	DivOperator
class	DivOperatorFactory
class	FieldCollection
	A class representing a collection of field documents in a database. More...
class	FieldDocument
	A class representing a field document in a database. More...
class	GaussGreenDiv
class	GaussGreenGrad
class	GeometricFieldMixin
	This class represents a mixin for a geometric field. More...
class	GeometryScheme
class	GeometrySchemeFactory
class	Linear
class	OldTimeCollection
class	OldTimeDocument
class	SurfaceBoundary
	Represents a surface boundary field for a cell-centered finite volume method. More...
class	SurfaceBoundaryFactory
class	SurfaceField
	Represents a surface field in a finite volume method. More...
class	SurfaceInterpolation
class	SurfaceInterpolationFactory
class	Upwind
class	VolumeBoundary
	Represents a volume boundary field for a cell-centered finite volume method. More...
class	VolumeBoundaryFactory
class	VolumeField
	Represents a volume field in a finite volume method. More...

Typedefs
using	CreateFunction = std::function< FieldDocument(NeoFOAM::Database &db)>
	A function type for creating a FieldDocument.

Functions
bool	validateFieldDoc (const Document &doc)
	Validates a FieldDocument.
template<typename FieldType >
FieldType &	oldTime (FieldType &field)
	Retrieves the old time field of a given field.
template<typename FieldType >
const FieldType &	oldTime (const FieldType &field)
	Retrieves the old time field of a given field (const version).
NeoFOAM::scalar	computeCoNum (const SurfaceField< NeoFOAM::scalar > &faceFlux, const scalar dt)
template<typename BoundaryType >
std::vector< BoundaryType >	createCalculatedBCs (const UnstructuredMesh &mesh)

Typedef Documentation

CreateFunction

using NeoFOAM::finiteVolume::cellCentred::CreateFunction = typedef std::function<FieldDocument(NeoFOAM::Database& db)>

A function type for creating a FieldDocument.

This function type is used to create a FieldDocument and creates a registered FieldType

Parameters

db	The database to create the FieldDocument in.

Returns

The created FieldDocument.

Definition at line 196 of file fieldCollection.hpp.

Function Documentation

computeCoNum()

NeoFOAM::scalar NeoFOAM::finiteVolume::cellCentred::computeCoNum	(	const SurfaceField< NeoFOAM::scalar > &	faceFlux,
		const scalar	dt
	)

createCalculatedBCs()

template<typename BoundaryType >

std::vector< BoundaryType > NeoFOAM::finiteVolume::cellCentred::createCalculatedBCs

(

const UnstructuredMesh &

mesh

)

Definition at line 26 of file boundary.hpp.

oldTime() [1/2]

template<typename FieldType >

const FieldType & NeoFOAM::finiteVolume::cellCentred::oldTime

(

const FieldType &

field

)

Retrieves the old time field of a given field (const version).

This function retrieves the old time field of a given field

Parameters

field

The field to retrieve the old time field from.

Returns

The old time field.

Definition at line 163 of file oldTimeCollection.hpp.

oldTime() [2/2]

template<typename FieldType >

FieldType & NeoFOAM::finiteVolume::cellCentred::oldTime

(

FieldType &

field

)

Retrieves the old time field of a given field.

This function retrieves the old time field of a given field

Parameters

field

The field to retrieve the old time field from.

Returns

The old time field.

Definition at line 147 of file oldTimeCollection.hpp.

validateFieldDoc()

bool NeoFOAM::finiteVolume::cellCentred::validateFieldDoc

(

const Document &

doc

)

Validates a FieldDocument.

This function validates a FieldDocument by checking if it contains the required fields.

Parameters

doc	The Document to validate.

Returns

true if the Document is valid, false otherwise.