Writes the multi-valve engine motion state. More...

Inheritance diagram for multiValveEngineState:

Collaboration diagram for multiValveEngineState:

Public Member Functions
	TypeName ("multiValveEngineState")
	Runtime type information. More...

	multiValveEngineState (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	multiValveEngineState (const multiValveEngineState &)=delete
	Disallow default bitwise copy construction. More...

virtual	~multiValveEngineState ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the multiValveEngineState data. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Execute, currently does nothing. More...

virtual bool	write ()
	Write the multiValveEngineState. More...

void	operator= (const multiValveEngineState &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from logFiles
	logFiles (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

	logFiles (const logFiles &)=delete
	Disallow default bitwise copy construction. More...

virtual	~logFiles ()
	Destructor. More...

const wordList &	toc () const
	Return the list of log file names. More...

const wordList &	names () const
	Return the list of log file names. More...

PtrList< OFstream > &	files ()
	Return access to the files. More...

OFstream &	file ()
	Return access to the file (if only 1) More...

OFstream &	file (const label i)
	Return file 'i'. More...

void	operator= (const logFiles &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

	writeFile (const writeFile &)=delete
	Disallow default bitwise copy construction. More...

	~writeFile ()
	Destructor. More...

void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

fileName	baseFileDir () const
	Return the base directory for output. More...

fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

void	writeTime (Ostream &os) const
	Write the current time to stream. More...

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair. More...

label	charWidth () const
	Return width of character stream output. More...

void	operator= (const writeFile &)=delete
	Disallow default bitwise assignment. More...

Protected Member Functions
virtual void	writeFileHeader (const label i)
	File header information. More...

Protected Member Functions inherited from fvMeshFunctionObject
labelHashSet	patchSet (const dictionary &, const bool optional=false) const
	Return the patch set corresponding to the patch selection entries. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Member Functions inherited from logFiles
virtual void	createFiles ()
	Create the output file. More...

virtual void	resetNames (const wordList &names)
	Reset the list of names from a wordList. More...

virtual void	resetName (const word &name)
	Reset the list of names to a single name entry. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Static Public Attributes inherited from writeFile
static const word	outputPrefix
	Directory prefix. More...

static label	addChars = 8
	Additional characters for writing. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Protected Attributes inherited from logFiles
wordList	names_
	File names. More...

PtrList< OFstream >	filePtrs_
	File pointer. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const word	prefix_
	Prefix. More...

Detailed Description

Writes the multi-valve engine motion state.

providing details of the position and speed of the piston and valves.

Usage

Property	Description	Required	Default value
`type`	type name: multiValveEngineState	yes

Example of function object specification:

    multiValveEngineState
    {
        type           multiValveEngineState;
        libs           ("libfvMeshMoversMultiValveEngine.so");
    }

See also: Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::logFiles Foam::fvMeshMovers::multiValveEngine

Source files

Definition at line 84 of file multiValveEngineState.H.

Constructor & Destructor Documentation

◆ multiValveEngineState() [1/2]

multiValveEngineState	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 58 of file multiValveEngineState.C.

References dict, and multiValveEngineState::read().

Here is the call graph for this function:

◆ multiValveEngineState() [2/2]

multiValveEngineState ( const multiValveEngineState & )

delete

Disallow default bitwise copy construction.

◆ ~multiValveEngineState()

~multiValveEngineState ( )

virtual

Destructor.

Definition at line 74 of file multiValveEngineState.C.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( const label i )

protectedvirtual

File header information.

Implements logFiles.

Definition at line 90 of file multiValveEngineState.C.

References Foam::endl(), Foam::file, forAll, multiValveEngine::movingObject::name, multiValveEngine::valves, and Foam::vtkWriteOps::writeHeader().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "multiValveEngineState" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the multiValveEngineState data.

Reimplemented from regionFunctionObject.

Definition at line 80 of file multiValveEngineState.C.

References dict, and regionFunctionObject::read().

Referenced by multiValveEngineState::multiValveEngineState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 132 of file multiValveEngineState.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 119 of file multiValveEngineState.C.

◆ write()

bool write ( )

virtual

Write the multiValveEngineState.

Reimplemented from logFiles.

Definition at line 125 of file multiValveEngineState.C.

References multiValveEngine::pistonObject::clearance(), multiValveEngine::pistonObject::displacement(), multiValveEngine::valveObject::displacement(), Foam::endl(), Foam::file, forAll, multiValveEngine::valveObject::isOpen(), multiValveEngine::valveObject::lift(), Log, UPstream::master(), multiValveEngine::movingObject::name, Foam::nl, multiValveEngine::piston, multiValveEngine::pistonObject::position(), multiValveEngine::pistonObject::speed(), multiValveEngine::valveObject::speed(), Foam::tab, multiValveEngine::valves, and logFiles::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const multiValveEngineState & )

delete

Disallow default bitwise assignment.

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

src/fvMeshMovers/multiValveEngine/multiValveEngineState/multiValveEngineState.H
src/fvMeshMovers/multiValveEngine/multiValveEngineState/multiValveEngineState.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ multiValveEngineState() [1/2]

◆ multiValveEngineState() [2/2]

◆ ~multiValveEngineState()

Member Function Documentation

◆ writeFileHeader()

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()