Public Member Functions
	engineValve (const word &name, const fvMeshMover &meshMover, const autoPtr< coordinateSystem > &valveCS, const word &bottomPatchName, const word &poppetPatchName, const word &stemPatchName, const word &curtainInPortPatchName, const word &curtainInCylinderPatchName, const word &detachInCylinderPatchName, const word &detachInPortPatchName, const labelList &detachFaces, const Function1s::Table< scalar > &liftProfile, const scalar minLift, const scalar minTopLayer, const scalar maxTopLayer, const scalar minBottomLayer, const scalar maxBottomLayer, const scalar diameter)
	Construct from components. More...

	engineValve (const word &name, const fvMeshMover &meshMover, const dictionary &dict)
	Construct from dictionary. More...

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

const word &	name () const
	Return name. More...

const coordinateSystem &	cs () const
	Return coordinate system. More...

const Function1s::Table< scalar > &	liftProfile () const
	Return lift profile. More...

scalar	diameter () const
	Return valve diameter. More...

const polyPatchID &	bottomPatchID () const
	Return ID of bottom patch. More...

const polyPatchID &	poppetPatchID () const
	Return ID of poppet patch. More...

const polyPatchID &	stemPatchID () const
	Return ID of stem patch. More...

const polyPatchID &	curtainInCylinderPatchID () const
	Return ID of curtain in cylinder patch. More...

const polyPatchID &	curtainInPortPatchID () const
	Return ID of curtain in port patch. More...

const polyPatchID &	detachInCylinderPatchID () const
	Return ID of detach in cylinder patch. More...

const polyPatchID &	detachInPortPatchID () const
	Return ID of detach in port patch. More...

const labelList &	detachFaces () const
	Return face labels of detach curtain. More...

scalar	minTopLayer () const

scalar	maxTopLayer () const

scalar	minBottomLayer () const

scalar	maxBottomLayer () const

scalar	lift (const scalar theta) const
	Return valve lift given crank angle in degrees. More...

bool	isOpen () const
	Is the valve open? More...

scalar	curLift () const
	Return current lift. More...

scalar	curVelocity () const
	Return valve velocity for current time-step. More...

labelList	movingPatchIDs () const
	Return list of active patch labels for the valve head. More...

void	writeDict (Ostream &) const
	Write dictionary. More...

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

Detailed Description

Foam::engineValve.

Source files

Definition at line 51 of file engineValve.H.

Constructor & Destructor Documentation

◆ engineValve() [1/3]

engineValve	(	const word &	name,
		const fvMeshMover &	meshMover,
		const autoPtr< coordinateSystem > &	valveCS,
		const word &	bottomPatchName,
		const word &	poppetPatchName,
		const word &	stemPatchName,
		const word &	curtainInPortPatchName,
		const word &	curtainInCylinderPatchName,
		const word &	detachInCylinderPatchName,
		const word &	detachInPortPatchName,
		const labelList &	detachFaces,
		const Function1s::Table< scalar > &	liftProfile,
		const scalar	minLift,
		const scalar	minTopLayer,
		const scalar	maxTopLayer,
		const scalar	minBottomLayer,
		const scalar	maxBottomLayer,
		const scalar	diameter
	)

Construct from components.

Definition at line 63 of file engineValve.C.

◆ engineValve() [2/3]

engineValve	(	const word &	name,
		const fvMeshMover &	meshMover,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 117 of file engineValve.C.

◆ engineValve() [3/3]

engineValve ( const engineValve & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ name()

const word& name ( ) const

inline

Return name.

Definition at line 175 of file engineValve.H.

◆ cs()

const coordinateSystem& cs ( ) const

inline

Return coordinate system.

Definition at line 181 of file engineValve.H.

◆ liftProfile()

const Function1s::Table<scalar>& liftProfile ( ) const

inline

Return lift profile.

Definition at line 187 of file engineValve.H.

◆ diameter()

scalar diameter ( ) const

inline

Return valve diameter.

Definition at line 193 of file engineValve.H.

◆ bottomPatchID()

const polyPatchID& bottomPatchID ( ) const

inline

Return ID of bottom patch.

Definition at line 202 of file engineValve.H.

◆ poppetPatchID()

const polyPatchID& poppetPatchID ( ) const

inline

Return ID of poppet patch.

Definition at line 208 of file engineValve.H.

◆ stemPatchID()

const polyPatchID& stemPatchID ( ) const

inline

Return ID of stem patch.

Definition at line 214 of file engineValve.H.

◆ curtainInCylinderPatchID()

const polyPatchID& curtainInCylinderPatchID ( ) const

inline

Return ID of curtain in cylinder patch.

Definition at line 220 of file engineValve.H.

◆ curtainInPortPatchID()

const polyPatchID& curtainInPortPatchID ( ) const

inline

Return ID of curtain in port patch.

Definition at line 226 of file engineValve.H.

◆ detachInCylinderPatchID()

const polyPatchID& detachInCylinderPatchID ( ) const

inline

Return ID of detach in cylinder patch.

Definition at line 233 of file engineValve.H.

◆ detachInPortPatchID()

const polyPatchID& detachInPortPatchID ( ) const

inline

Return ID of detach in port patch.

Definition at line 239 of file engineValve.H.

◆ detachFaces()

const labelList& detachFaces ( ) const

inline

Return face labels of detach curtain.

Definition at line 245 of file engineValve.H.

◆ minTopLayer()

scalar minTopLayer ( ) const

inline

Definition at line 253 of file engineValve.H.

◆ maxTopLayer()

scalar maxTopLayer ( ) const

inline

Definition at line 258 of file engineValve.H.

◆ minBottomLayer()

scalar minBottomLayer ( ) const

inline

Definition at line 263 of file engineValve.H.

◆ maxBottomLayer()

scalar maxBottomLayer ( ) const

inline

Definition at line 268 of file engineValve.H.

◆ lift()

Foam::scalar lift ( const scalar theta ) const

Return valve lift given crank angle in degrees.

Definition at line 172 of file engineValve.C.

◆ isOpen()

bool isOpen ( ) const

Is the valve open?

Definition at line 178 of file engineValve.C.

◆ curLift()

Foam::scalar curLift ( ) const

Return current lift.

Definition at line 184 of file engineValve.C.

References Foam::max().

Here is the call graph for this function:

◆ curVelocity()

Foam::scalar curVelocity ( ) const

Return valve velocity for current time-step.

Definition at line 194 of file engineValve.C.

References Foam::max().

Here is the call graph for this function:

◆ movingPatchIDs()

Foam::labelList movingPatchIDs ( ) const

Return list of active patch labels for the valve head.

(stem is excluded)

Definition at line 208 of file engineValve.C.

References List< T >::setSize().

Here is the call graph for this function:

◆ writeDict()

void writeDict ( Ostream & os ) const

Write dictionary.

Definition at line 231 of file engineValve.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::END_STATEMENT, Foam::endl(), IOstream::name(), Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ operator=()

void operator= ( const engineValve & )

delete

Disallow default bitwise assignment.

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

src/fvMeshMovers/engine/engineValve/engineValve.H
src/fvMeshMovers/engine/engineValve/engineValve.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ engineValve() [1/3]

◆ engineValve() [2/3]

◆ engineValve() [3/3]

Member Function Documentation

◆ name()

◆ cs()

◆ liftProfile()

◆ diameter()

◆ bottomPatchID()

◆ poppetPatchID()

◆ stemPatchID()

◆ curtainInCylinderPatchID()

◆ curtainInPortPatchID()

◆ detachInCylinderPatchID()

◆ detachInPortPatchID()

◆ detachFaces()

◆ minTopLayer()

◆ maxTopLayer()

◆ minBottomLayer()

◆ maxBottomLayer()

◆ lift()

◆ isOpen()

◆ curLift()

◆ curVelocity()

◆ movingPatchIDs()

◆ writeDict()

◆ operator=()