Calculates propeller performance and wake field properties. More...

Inheritance diagram for propellerInfo:

Collaboration diagram for propellerInfo:

[legend]

Public Types
enum	rotationMode { SPECIFIED, MRF }

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

	propellerInfo (const word &name, const Time &runTime, const dictionary &dict, const bool readFields=true)
	Construct from Time and dictionary. More...

	propellerInfo (const word &name, const objectRegistry &obr, const dictionary &dict, const bool readFields=true)
	Construct from objectRegistry and dictionary. More...

virtual	~propellerInfo ()=default
	Destructor. More...

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

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

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

void	UpdateMesh (const mapPolyMesh &mpm)

void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &psi, const Type &defaultValue) const

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

	forces (const word &name, const Time &runTime, const dictionary &dict, const bool readFields=true)
	Construct from Time and dictionary. More...

	forces (const word &name, const objectRegistry &obr, const dictionary &dict, const bool readFields=true)
	Construct from objectRegistry and dictionary. More...

	forces (const forces &)=delete
	No copy construct. More...

void	operator= (const forces &)=delete
	No copy assignment. More...

virtual	~forces ()=default
	Destructor. More...

virtual void	calcForcesMoments ()
	Calculate forces and moments. More...

virtual vector	forceEff () const
	Return the total force. More...

virtual vector	momentEff () const
	Return the total moment. 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...

virtual	~fvMeshFunctionObject ()=default
	Destructor. 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...

virtual	~regionFunctionObject ()=default
	Destructor. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set new trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

bool	getObjectResultDict (const word &objectName, dictionary &dict) const

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time. More...

const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time. More...

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

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

virtual	~functionObject ()=default
	Destructor. More...

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

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

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

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

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName. More...

	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary. More...

	writeFile (const writeFile &wf)
	Construct copy. More...

virtual	~writeFile ()=default
	Destructor. More...

virtual const string &	setExt (const string &ext)
	Set extension. More...

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

virtual bool	writeToFile () const
	Flag to allow writing to file. More...

virtual bool	canWriteToFile () const
	Flag to allow writing to the file. More...

virtual bool	canResetFile () const
	Flag to allow resetting the file. More...

virtual bool	canWriteHeader () const
	Flag to allow writing the header. More...

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

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

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

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

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

virtual void	writeBreak (Ostream &os) const
	Write a break marker to the 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...

template<class Type >
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter. More...

Static Public Attributes
static const Enum< rotationMode >	rotationModeNames_

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing. More...

Protected Member Functions
void	setCoordinateSystem (const dictionary &dict)
	Set the coordinate system. More...

void	setRotationalSpeed ()
	Set the rotational speed. More...

void	createFiles ()
	Create output files. More...

const volVectorField &	U () const
	Return the velocity field. More...

void	writePropellerPerformance ()
	Write the wake fields. More...

void	writeWake (const vectorField &U, const scalar URef)
	Write the wake text file. More...

void	writeAxialWake (const vectorField &U, const scalar URef)
	Write the axial wake text file. More...

void	writeWakeFields (const scalar URef)
	Write the wake fields. More...

void	setSampleDiskGeometry (const coordinateSystem &coordSys, const scalar r1, const scalar r2, const scalar nTheta, const label nRadius, faceList &faces, pointField &points) const
	Set the faces and points for the sample surface. More...

void	setSampleDiskSurface (const dictionary &dict)
	Set the sample surface based on dictionary settings. More...

void	updateSampleDiskCells ()
	Set the sample cells corresponding to the sample points. More...

scalar	meanSampleDiskField (const scalarField &field) const
	Return the area average of a field. More...

void	writeSampleDiskSurface (const vectorField &U, const vectorField &Ur, const scalar URef)
	Write the sample surface. More...

template<class Type >
tmp< Field< Type > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &psi, const Type &defaultValue) const
	Interpolate from the mesh onto the sample surface. More...

	propellerInfo (const propellerInfo &)=delete
	No copy construct. More...

void	operator= (const propellerInfo &)=delete
	No copy assignment. More...

Protected Member Functions inherited from forces
void	setCoordinateSystem (const dictionary &dict, const word &e3Name=word::null, const word &e1Name=word::null)
	Set the co-ordinate system from dictionary and axes names. More...

volVectorField &	force ()
	Return access to the force field. More...

volVectorField &	moment ()
	Return access to the moment field. More...

void	initialise ()
	Initialise containers and fields. More...

void	reset ()
	Reset containers and fields. More...

tmp< symmTensorField >	devRhoReff (const tensorField &gradUp, const label patchi) const
	Return the effective stress (viscous + turbulent) for patch. More...

tmp< volScalarField >	mu () const
	Return dynamic viscosity field. More...

tmp< volScalarField >	rho () const
	Return rho if specified otherwise rhoRef. More...

tmp< scalarField >	rho (const label patchi) const
	Return rho if specified otherwise rhoRef for patch. More...

scalar	rho (const volScalarField &p) const
	Return rhoRef if the pressure field is dynamic (i.e. p/rho), otherwise return 1. More...

void	addToPatchFields (const label patchi, const vectorField &Md, const vectorField &fP, const vectorField &fV)
	Add patch contributions to force and moment fields. More...

void	addToInternalField (const labelList &cellIDs, const vectorField &Md, const vectorField &f)
	Add cell contributions to force and moment fields, and include porosity effects. More...

void	createIntegratedDataFiles ()
	Create the integrated-data files. More...

void	writeIntegratedDataFileHeader (const word &header, OFstream &os) const
	Write header for an integrated-data file. More...

void	writeIntegratedDataFiles ()
	Write integrated data to files. More...

void	writeIntegratedDataFile (const vector &pres, const vector &vis, const vector &internal, OFstream &os) const
	Write integrated data to a file. More...

void	logIntegratedData (const string &descriptor, const vector &pres, const vector &vis, const vector &internal) const
	Write integrated data to stream. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry. More...

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

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

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

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

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

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Member Functions inherited from writeFile
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...

fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name. More...

virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name. More...

virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time. More...

virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name. More...

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

void	operator= (const writeFile &)=delete
	No copy assignment. More...

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time. More...

Protected Attributes
dictionary	dict_
	Copy of dictionary used during construction. More...

scalar	radius_
	Propeller radius. More...

autoPtr< Function1< scalar > >	URefPtr_
	Reference velocity. More...

rotationMode	rotationMode_
	Rotation mode. More...

word	MRFName_
	Name of MRF zone (if applicable) More...

scalar	n_
	Propeller speed (revolutions per second) More...

bool	writePropellerPerformance_
	Flag to write performance data. More...

autoPtr< OFstream >	propellerPerformanceFilePtr_
	Propeller performance file. More...

bool	writeWakeFields_
	Flag to write wake fields. More...

autoPtr< surfaceWriter >	surfaceWriterPtr_
	Surface writer. More...

label	nTheta_
	Number of surface divisions in theta direction. More...

label	nRadial_
	Number of surface divisions in radial direction. More...

pointField	points_
	Surface points. More...

bool	errorOnPointNotFound_
	Flag to raise an error if the sample point is not found in the mesh. Default = false to enable. e.g. reduced geometry/symmetric cases. More...

faceList	faces_
	Surface faces. More...

labelList	cellIds_
	Surface point sample cell IDs. More...

boolList	pointMask_
	List of participating points (parallel reduced) More...

word	interpolationScheme_
	Interpolation scheme. More...

autoPtr< OFstream >	wakeFilePtr_
	Wake field file. More...

autoPtr< OFstream >	axialWakeFilePtr_
	Axial wake field file. More...

scalar	nanValue_
	Default value when a sample point is not found; default = scalar::min. More...

bool	initialised_
	Initialised flag. More...

Protected Attributes inherited from forces
vector	sumPatchForcesP_
	Sum of patch pressure forces. More...

vector	sumPatchForcesV_
	Sum of patch viscous forces. More...

vector	sumPatchMomentsP_
	Sum of patch pressure moments. More...

vector	sumPatchMomentsV_
	Sum of patch viscous moments. More...

vector	sumInternalForces_
	Sum of internal forces. More...

vector	sumInternalMoments_
	Sum of internal moments. More...

autoPtr< OFstream >	forceFilePtr_
	File stream for forces. More...

autoPtr< OFstream >	momentFilePtr_
	File stream for moments. More...

autoPtr< coordinateSystem >	coordSysPtr_
	Coordinate system used when evaluating forces and moments. More...

labelList	patchIDs_
	Selected operand patches. More...

scalar	rhoRef_
	Reference density needed for incompressible calculations. More...

scalar	pRef_
	Reference pressure. More...

word	pName_
	Name of pressure field. More...

word	UName_
	Name of velocity field. More...

word	rhoName_
	Name of density field. More...

word	fDName_
	Name of force density field. More...

bool	directForceDensity_
	Flag to directly supply force density. More...

bool	porosity_
	Flag to include porosity effects. More...

bool	writeFields_
	Flag to write force and moment fields. More...

bool	initialised_
	Flag of initialisation (internal) More...

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

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

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

const fileName	prefix_
	Prefix. More...

word	fileName_
	Name of file. More...

autoPtr< OFstream >	filePtr_
	File pointer. More...

label	writePrecision_
	Write precision. More...

bool	writeToFile_
	Flag to enable/disable writing to file. More...

bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true. More...

bool	writtenHeader_
	Flag to identify whether the header has been written. More...

bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true. More...

scalar	startTime_
	Start time value. More...

string	ext_
	File extension; default = .dat. More...

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

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Detailed Description

Calculates propeller performance and wake field properties.

Controlled by executeControl:

Propeller performance
- Thrust coefficient, Kt
- Torque coefficient, 10*Kq
- Advance coefficient, J
- Open water efficiency, etaO
- Written to postProcessing/<name>/<time>/propellerPerformance.dat

Controlled by writeControl:

Wake field text file
- Wake: 1 - UzMean/URef
- Velocity in cylindrical coordinates at xyz locations
- Written to postProcessing/<name>/<time>/wake.dat
Axial wake field text file
- 1 - Uz/URef at r/R and angle
- Written to postProcessing/<name>/<time>/axialWake.dat
Velocity surface
- Written to postProcessing/<name>/surfaces/<time>/disk.<fileType>

Usage

Example of function object specification:

propellerInfo1
{
    type            propellerInfo;
    libs            (forces);
    writeControl    writeTime;

    patches         ("propeller.*");

    URef            5; // Function1 type; 'constant' form shown here
    rho             rhoInf; // incompressible
    rhoInf          1.2;

    // Optionally write propeller performance data
    writePropellerPerformance yes;


    // Propeller data:

    // Radius
    radius          0.1;

    rotationMode    specified; // specified | MRF

    // rotationMode = specified:
    origin          (0 -0.1 0);
    n               25.15;
    axis            (0 1 0);

    // Optional reference direction for angle (alpha) = 0
    alphaAxis       (1 0 0);


    //// rotationMode = mrf
    //// MRF             MRFZoneName;
    //// (origin, n and axis retrieved from MRF model)

    // Optionally write wake text files
    // Note: controlled by writeControl
    writeWakeFields yes;

    // Sample plane (disk) properties
    // Note: controlled by writeControl
    sampleDisk
    {
        surfaceWriter   vtk;
        r1              0.05;
        r2              0.2;
        nTheta          36;
        nRadial         10;
        interpolationScheme cellPoint;
        errorOnPointNotFound false;
    }
}

Where the entries comprise:

Property	Description	Required	Deflt value
`type`	Type name: propellerInfo	yes
`log`	Write to standard output	no	no
`patches`	Patches included in the forces calculation	yes
`p`	Pressure field name	no	p
`U`	Velocity field name	no	U
`rho`	Density field name	no	rho
`URef`	Reference velocity	yes
`rotationMode`	Rotation mode (see below)	yes
`origin`	Sample disk centre	no*
`n`	Revolutions per second	no*
`axis`	Propeller axis	no*
`alphaAxis`	Axis that defines alpha=0 dir	no
`MRF`	Name of MRF zone	no*
`originOffset`	Origin offset for MRF mode	no	(0 0 0)
`writePropellerPerformance`	Write propeller performance text file	yes
`writeWakeFields`	Write wake field text files	yes
`surfaceWriter`	Sample disk surface writer	no*
`r1`	Sample disk inner radius	no	0
`r2`	Sample disk outer radius	no*
`nTheta`	Divisions in theta direction	no*
`nRadial`	Divisions in radial direction	no*
`interpolationScheme`	Sampling interpolation scheme	no*	cell

Note

URef is a scalar Function1 type, i.e. supports constant, table, lookup values
rotationMode is used to set the origin, axis and revolutions per second
- if set to 'specified' all 3 entries are required
  - note: origin is the sample disk origin
- if set to 'MRF' only the MRF entry is required
  - to move the sample disk away from the MRF origin, use the originOffset
if writePropellerPerformance is set to on|true:
- propellerPerformance text file will be written
if writeWakeFields is set to on|true:
- wake and axialWake text files will be written
if the surfaceWriter entry is set, the sample disk surface will be written
- extents set according to the r1 and r2 entries
- discretised according to the nTheta and nRadial entries

See also: Foam::functionObject::forces Foam::Function1

Source files

Definition at line 298 of file propellerInfo.H.

Member Enumeration Documentation

◆ rotationMode

enum rotationMode

strong

Enumerator
SPECIFIED
MRF

Definition at line 305 of file propellerInfo.H.

Constructor & Destructor Documentation

◆ propellerInfo() [1/3]

propellerInfo ( const propellerInfo & )

protecteddelete

No copy construct.

◆ propellerInfo() [2/3]

propellerInfo	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const bool	readFields = `true`
	)

Construct from Time and dictionary.

Definition at line 796 of file propellerInfo.C.

References dict, Foam::endl(), Log, and Foam::read().

Here is the call graph for this function:

◆ propellerInfo() [3/3]

propellerInfo	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	readFields = `true`
	)

Construct from objectRegistry and dictionary.

Definition at line 836 of file propellerInfo.C.

◆ ~propellerInfo()

virtual ~propellerInfo ( )

virtualdefault

Destructor.

Member Function Documentation

◆ setCoordinateSystem()

void setCoordinateSystem ( const dictionary & dict )

protected

Set the coordinate system.

Definition at line 54 of file propellerInfo.C.

References Foam::abort(), dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, FatalIOErrorInFunction, Foam::mag(), MRF, Foam::constant::mathematical::twoPi(), and Foam::Zero.

Here is the call graph for this function:

◆ setRotationalSpeed()

void setRotationalSpeed ( )

protected

Set the rotational speed.

Definition at line 130 of file propellerInfo.C.

References Foam::abort(), objectRegistry::cfindObject(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fvMeshFunctionObject::mesh_, propellerInfo::MRF, propellerInfo::MRFName_, propellerInfo::n_, propellerInfo::rotationMode_, propellerInfo::rotationModeNames_, propellerInfo::SPECIFIED, and Foam::constant::mathematical::twoPi().

Here is the call graph for this function:

◆ createFiles()

void createFiles ( )

protected

Create output files.

Definition at line 168 of file propellerInfo.C.

References Foam::nl, os(), and Foam::writeHeader().

Here is the call graph for this function:

◆ U()

const Foam::volVectorField & U ( ) const

protected

Return the velocity field.

Definition at line 207 of file propellerInfo.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::flatOutput().

Here is the call graph for this function:

◆ writePropellerPerformance()

void writePropellerPerformance ( )

protected

Write the wake fields.

Definition at line 554 of file propellerInfo.C.

References Log, Foam::mag(), Foam::name(), Foam::nl, os(), Foam::pow4(), Foam::sign(), Foam::sqr(), Foam::tab, Foam::constant::mathematical::twoPi(), and Foam::type().

Here is the call graph for this function:

◆ writeWake()

void writeWake	(	const vectorField &	U,
		const scalar	URef
	)

protected

Write the wake text file.

Definition at line 613 of file propellerInfo.C.

References Foam::endl(), Foam::mag(), UPstream::master(), Foam::nl, os(), Foam::tab, U, and Foam::writeHeader().

Here is the call graph for this function:

◆ writeAxialWake()

void writeAxialWake	(	const vectorField &	U,
		const scalar	URef
	)

protected

Write the axial wake text file.

Definition at line 672 of file propellerInfo.C.

References Foam::endl(), Foam::mag(), UPstream::master(), Foam::nl, os(), Foam::tab, and U.

Here is the call graph for this function:

◆ writeWakeFields()

void writeWakeFields ( const scalar URef )

protected

Write the wake fields.

Definition at line 731 of file propellerInfo.C.

References Foam::endl(), Foam::interpolate(), Foam::mag(), U, and WarningInFunction.

Here is the call graph for this function:

◆ setSampleDiskGeometry()

void setSampleDiskGeometry	(	const coordinateSystem &	coordSys,
		const scalar	r1,
		const scalar	r2,
		const scalar	nTheta,
		const label	nRadius,
		faceList &	faces,
		pointField &	points
	)		const

protected

Set the faces and points for the sample surface.

Definition at line 225 of file propellerInfo.C.

References DynamicList< T, SizeMin >::append(), DynamicList< T, SizeMin >::clear(), UList< T >::fcIndex(), coordinateSystem::globalPosition(), Foam::identity(), coordinateSystem::origin(), p, points, List< T >::setSize(), and Foam::constant::mathematical::twoPi().

Here is the call graph for this function:

◆ setSampleDiskSurface()

void setSampleDiskSurface ( const dictionary & dict )

protected

Set the sample surface based on dictionary settings.

Definition at line 328 of file propellerInfo.C.

References dict, surfaceWriter::formatOptions(), dictionary::getScalar(), and surfaceWriter::New().

Here is the call graph for this function:

◆ updateSampleDiskCells()

void updateSampleDiskCells ( )

protected

Set the sample cells corresponding to the sample points.

Definition at line 378 of file propellerInfo.C.

References Foam::abort(), polyMesh::CELL_TETS, treeBoundBox::contains(), DebugInfo, Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, found, boundBox::inflate(), Pstream::listCombineReduce(), UPstream::myProcNo(), Foam::pos(), Foam::reduce(), and tree().

Here is the call graph for this function:

◆ meanSampleDiskField()

Foam::scalar meanSampleDiskField ( const scalarField & field ) const

protected

Return the area average of a field.

Definition at line 477 of file propellerInfo.C.

References Foam::abort(), Foam::fieldTypes::area, f(), Foam::FatalError, FatalErrorInFunction, field(), and forAll.

Here is the call graph for this function:

◆ writeSampleDiskSurface()

void writeSampleDiskSurface	(	const vectorField &	U,
		const vectorField &	Ur,
		const scalar	URef
	)

protected

Write the sample surface.

Definition at line 521 of file propellerInfo.C.

References Foam::name(), and U.

Here is the call graph for this function:

◆ interpolate() [1/2]

tmp<Field<Type> > interpolate	(	const GeometricField< Type, fvPatchField, volMesh > &	psi,
		const Type &	defaultValue
	)		const

protected

Interpolate from the mesh onto the sample surface.

◆ operator=()

void operator= ( const propellerInfo & )

protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "propellerInfo" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the forces data.

Reimplemented from forces.

Definition at line 849 of file propellerInfo.C.

References dict, and forces::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Reimplemented from forces.

Definition at line 877 of file propellerInfo.C.

References initialised_(), Foam::interpolate(), and U.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the forces.

Reimplemented from forces.

Definition at line 924 of file propellerInfo.C.

◆ UpdateMesh()

void UpdateMesh ( const mapPolyMesh & mpm )

Definition at line 933 of file propellerInfo.C.

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for changes of mesh.

The base implementation is a no-op.

Reimplemented from functionObject.

Definition at line 939 of file propellerInfo.C.

◆ interpolate() [2/2]

Foam::tmp<Foam::Field<Type> > interpolate	(	const GeometricField< Type, fvPatchField, volMesh > &	psi,
		const Type &	defaultValue
	)		const

Definition at line 763 of file propellerInfo.C.

References field(), forAll, Pstream::listCombineReduce(), Foam::New(), and psi.

Here is the call graph for this function:

Member Data Documentation

◆ rotationModeNames_

const Foam::Enum< Foam::functionObjects::propellerInfo::rotationMode > rotationModeNames_

static

Definition at line 311 of file propellerInfo.H.

Referenced by propellerInfo::setRotationalSpeed().

◆ dict_

dictionary dict_

protected

Copy of dictionary used during construction.

Definition at line 321 of file propellerInfo.H.

◆ radius_

scalar radius_

protected

Propeller radius.

Definition at line 326 of file propellerInfo.H.

◆ URefPtr_

autoPtr<Function1<scalar> > URefPtr_

protected

Reference velocity.

Definition at line 331 of file propellerInfo.H.

◆ rotationMode_

rotationMode rotationMode_

protected

Rotation mode.

Definition at line 336 of file propellerInfo.H.

Referenced by propellerInfo::setRotationalSpeed().

◆ MRFName_

word MRFName_

protected

Name of MRF zone (if applicable)

Definition at line 341 of file propellerInfo.H.

Referenced by propellerInfo::setRotationalSpeed().

◆ n_

scalar n_

protected

Propeller speed (revolutions per second)

Definition at line 346 of file propellerInfo.H.

Referenced by propellerInfo::setRotationalSpeed().

◆ writePropellerPerformance_

bool writePropellerPerformance_

protected

Flag to write performance data.

Definition at line 351 of file propellerInfo.H.

◆ propellerPerformanceFilePtr_

autoPtr<OFstream> propellerPerformanceFilePtr_

protected

Propeller performance file.

Definition at line 356 of file propellerInfo.H.

◆ writeWakeFields_

bool writeWakeFields_

protected

Flag to write wake fields.

Definition at line 361 of file propellerInfo.H.

◆ surfaceWriterPtr_

autoPtr<surfaceWriter> surfaceWriterPtr_

protected

Surface writer.

Definition at line 369 of file propellerInfo.H.

◆ nTheta_

label nTheta_

protected

Number of surface divisions in theta direction.

Definition at line 374 of file propellerInfo.H.

◆ nRadial_

label nRadial_

protected

Number of surface divisions in radial direction.

Definition at line 379 of file propellerInfo.H.

◆ points_

pointField points_

protected

Surface points.

Definition at line 384 of file propellerInfo.H.

◆ errorOnPointNotFound_

bool errorOnPointNotFound_

protected

Flag to raise an error if the sample point is not found in the mesh. Default = false to enable. e.g. reduced geometry/symmetric cases.

Definition at line 391 of file propellerInfo.H.

◆ faces_

faceList faces_

protected

Surface faces.

Definition at line 396 of file propellerInfo.H.

◆ cellIds_

labelList cellIds_

protected

Surface point sample cell IDs.

Definition at line 401 of file propellerInfo.H.

◆ pointMask_

boolList pointMask_

protected

List of participating points (parallel reduced)

Definition at line 406 of file propellerInfo.H.

◆ interpolationScheme_

word interpolationScheme_

protected

Interpolation scheme.

Definition at line 411 of file propellerInfo.H.

◆ wakeFilePtr_

autoPtr<OFstream> wakeFilePtr_

protected

Wake field file.

Definition at line 416 of file propellerInfo.H.

◆ axialWakeFilePtr_

autoPtr<OFstream> axialWakeFilePtr_

protected

Axial wake field file.

Definition at line 421 of file propellerInfo.H.

◆ nanValue_

scalar nanValue_

protected

Default value when a sample point is not found; default = scalar::min.

Definition at line 427 of file propellerInfo.H.

◆ initialised_

bool initialised_

protected

Initialised flag.

Definition at line 432 of file propellerInfo.H.

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

src/functionObjects/forces/propellerInfo/propellerInfo.H
src/functionObjects/forces/propellerInfo/propellerInfo.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ rotationMode

Constructor & Destructor Documentation

◆ propellerInfo() [1/3]

◆ propellerInfo() [2/3]

◆ propellerInfo() [3/3]

◆ ~propellerInfo()

Member Function Documentation

◆ setCoordinateSystem()

◆ setRotationalSpeed()

◆ createFiles()

◆ U()

◆ writePropellerPerformance()

◆ writeWake()

◆ writeAxialWake()

◆ writeWakeFields()

◆ setSampleDiskGeometry()

◆ setSampleDiskSurface()

◆ updateSampleDiskCells()

◆ meanSampleDiskField()

◆ writeSampleDiskSurface()

◆ interpolate() [1/2]

◆ operator=()

◆ TypeName()

◆ read()

◆ execute()

◆ write()

◆ UpdateMesh()

◆ movePoints()

◆ interpolate() [2/2]

Member Data Documentation

◆ rotationModeNames_

◆ dict_

◆ radius_

◆ URefPtr_

◆ rotationMode_

◆ MRFName_

◆ n_

◆ writePropellerPerformance_

◆ propellerPerformanceFilePtr_

◆ writeWakeFields_

◆ surfaceWriterPtr_

◆ nTheta_

◆ nRadial_

◆ points_

◆ errorOnPointNotFound_

◆ faces_

◆ cellIds_

◆ pointMask_

◆ interpolationScheme_

◆ wakeFilePtr_

◆ axialWakeFilePtr_

◆ nanValue_

◆ initialised_