dsmcFields Class Reference

This function object calculates and outputs the intensive fields: More...

Collaboration diagram for dsmcFields:

Public Member Functions
	TypeName ("dsmcFields")
	Runtime type information. More...
	dsmcFields (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct for given objectRegistry and dictionary. More...
virtual	~dsmcFields ()
	Destructor. More...
virtual const word &	name () const
	Return name of the set of dsmcFields. More...
virtual void	read (const dictionary &)
	Read the dsmcFields data. More...
virtual void	execute ()
	Execute, currently does nothing. More...
virtual void	end ()
	Execute at the final time-loop, currently does nothing. More...
virtual void	timeSet ()
	Called when time was set at the end of the Time::operator++. More...
virtual void	write ()
	Calculate the dsmcFields and write. More...
virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh. More...
virtual void	movePoints (const polyMesh &)
	Update for changes of mesh. More...

Private Member Functions
	dsmcFields (const dsmcFields &)
	Disallow default bitwise copy construct. More...
void	operator= (const dsmcFields &)
	Disallow default bitwise assignment. More...

Private Attributes
word	name_
	Name of this set of dsmcFields objects. More...
const objectRegistry &	obr_
bool	active_
	on/off switch More...
Switch	log_
	Switch to send output to Info as well as to file. More...

Detailed Description

This function object calculates and outputs the intensive fields:

- UMean

• translationalT
• internalT
• overallT from averaged extensive fields from a DSMC calculation.

Example of function object specification to calculate DSMC fields:

dsmcFields1
{
    type        dsmcFields;
    functionObjectLibs ("libutilityFunctionObjects.so");
    ...
}

Function object usage

Property	Description	Required	Default value
type	Type name: dsmcFields	yes
log	Log to standard output	no	yes

Source files

• dsmcFields.H
• dsmcFields.C
• IOdsmcFields.H

Definition at line 98 of file dsmcFields.H.

Constructor & Destructor Documentation

dsmcFields() [1/2]

dsmcFields ( const dsmcFields &  )

private

Disallow default bitwise copy construct.

dsmcFields() [2/2]

dsmcFields	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	loadFromFiles = false
	)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 46 of file dsmcFields.C.

References dict, Foam::endl(), Foam::nl, Foam::read(), and WarningInFunction.

Here is the call graph for this function:

~dsmcFields()

~dsmcFields ( )

virtual

Destructor.

Definition at line 73 of file dsmcFields.C.

Member Function Documentation

operator=()

void operator= ( const dsmcFields &  )

private

Disallow default bitwise assignment.

TypeName()

TypeName

(

"dsmcFields"

)

Runtime type information.

name()

virtual const word& name ( ) const

inlinevirtual

Return name of the set of dsmcFields.

Definition at line 149 of file dsmcFields.H.

References dsmcFields::name_.

read()

void read ( const dictionary &  dict )

virtual

Read the dsmcFields data.

Definition at line 79 of file dsmcFields.C.

References dict.

execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 88 of file dsmcFields.C.

end()

void end ( )

virtual

Execute at the final time-loop, currently does nothing.

Definition at line 94 of file dsmcFields.C.

timeSet()

void timeSet ( )

virtual

Called when time was set at the end of the Time::operator++.

Definition at line 100 of file dsmcFields.C.

write()

void write ( )

virtual

Calculate the dsmcFields and write.

Definition at line 106 of file dsmcFields.C.

References Foam::endl(), polyPatch::faceAreas(), forAll, Foam::Info, Foam::constant::physicoChemical::k, Foam::mag(), Foam::max(), mesh, Foam::min(), Foam::nl, IOobject::NO_READ, p, Foam::type(), UMean(), and dimensioned::value().

Here is the call graph for this function:

updateMesh()

virtual void updateMesh ( const mapPolyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 170 of file dsmcFields.H.

movePoints()

virtual void movePoints ( const polyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 174 of file dsmcFields.H.

Field Documentation

name_

word name_

private

Name of this set of dsmcFields objects.

Definition at line 103 of file dsmcFields.H.

Referenced by dsmcFields::name().

obr_

const objectRegistry& obr_

private

Definition at line 105 of file dsmcFields.H.

active_

bool active_

private

on/off switch

Definition at line 108 of file dsmcFields.H.

log_

Switch log_

private

Switch to send output to Info as well as to file.

Definition at line 111 of file dsmcFields.H.

---

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

• src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H
• src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.C