Gerotor inputDict Definition

This is a list of all the variables in the tutorial Gerotor inputDict. Check out this page for more details on the units.

aTolConv

Absolute convergence tolerance used in convergence tolerance equation as:

\(error \leq |y_i|*rTolConv + |y_{char_i}|*aTolConv\)

Default: 1e-5 Unit: -

bearingAutoCorr

Unit: micron

bearingRoughness

Unit: micron

bearingVarRat

Unit: -

bunsenCoef

Bunsen coefficient of the liquid

Unit: -

cavType

Cavitation type (only relevant for fluidType>0)

  • 0 - static cavitation

  • 1 - dynamic cavitation

Unit: -

coefRestitution

Contact Formulation

Unit: -

cqMaxInlet

Max discharge coefficient for general orifice (if not given, defaults to 0.7)

Unit: -

cqMaxOutlet

Unit: -

delHfilm

Percent change in gap height over a single explicit step

Unit: %

deliveryPortPolygon

Lateral gap tooth profiles

deltaDotMinusLim

Limiting Impact Velocity

Unit: m/s

delVfilm

Percent change in gap velocity over a single explicit step

Unit: %

DensityDrive

Drive Gear Density

Unit: kg/m 3

DensityDriven

Driven Gear Density

Unit: kg/m 3

driveDiameterJb

Drive Gear Diameter Journal Bearing

Unit: mm

driveJbClear

Drive Journal Bearing Body Young’s Modulus

Unit: micron

driveLenJb

Drive Gear Journal Length

Unit: mm

drivenDiameterJb

Driven Diameter Journal Bearing

Unit: mm

drivenJbClear

Driven Journal Bearing Body Young’s Modulus

Unit: micron

ecc

eccentricity of the gears

Unit:* mm

EDrive

Drive Gear Young’s Modulus

Unit: GPa_a

EDriven

Driven Gear Young’s Modulus

Unit: GPa_a

EJbBodyDrive

Unit: GPa_a

EJbBodyDriven

Unit: GPa_a

ELateral

Unit: GPa_a

endPrint

Time to end simulation

Unit: s

faceWidth

Gear’s face width

Unit: mm

filmSolver

Film solver:

  • 0 - Default

  • 1 - ExplicitSingleStep

  • 2 - ExplicitMultiStep

  • -1 - ImplicitSingleStep

  • -2 - ImplicitMultiStep

Unit: -

FluidpRef

Definition of “reference” conditions

Unit: bar

fluidPropSuper

Location of fluid property files for sub/super atmospheric

FluidTRef

Definition of “reference” conditions

Unit: degC

fluidType

Specifies the way that fluid properties are acquired.

Inputs:

  • 0 - Super atmospheric and sub atmospheric fluid properties with cavitation stored in input fluid files.

  • 1 - Super atmospheric fluid properties stored in input files, and sub atmospheric fluid properties are calculated with cavitation models.

  • 2 - Fluid properties are expression based, and cavitation is calculated with one of the models.

Unit: -

gammaGas

Released Gas polytropic index

Unit: -

gammaVap

Vapor polytropic index

Unit: -

gapBearingIsLined

Journal Bearing Side

Unit: -

gapLateralIsLined

Lateral Side

Unit: -

geometryTableFile

Location of geometry file

HLInletD

Hydraulic Line Inlet

Unit: mm

HLInletElasticModulus

Unit: GPa_a

HLInletL

Unit: mm

HLInletPoisson

Unit: -

HLInletRoughness

Unit: micron

HLInletThickness

Unit: mm

HLOutletD

Hydraulic Line Outlet

Unit: mm

HLOutletElasticModulus

Unit: GPa_a

HLOutletL

Unit: mm

HLOutletPoisson

Unit: -

HLOutletRoughness

Unit: micron

HLOutletThickness

Unit: mm

initOTP

Unit: bar

initShaftSpeed

Batch Run

Unit: rev/min

inletOrifD

Inlet Port Hydraulic Diameter

Unit: mm

inletp

Inlet Pressure

Unit: bar

inletT

Inlet Temperature

Unit: degC

inletVolume

Inlet Volume

Unit: cm 3

innerJournalPolygon

Lateral gap tooth profiles

innerLateralPolygon

Lateral gap tooth profiles

innerRotorPolygon

Lateral gap tooth profiles

intvPrint

Time of printing interval to print to results file

Unit: s

isFilmMixed

Flag notifying that the JB mixed lubrication is to be solved for

Unit: -

isMicroMotion

weather the gears have micromotion enabled

Unit: -

isSnapPoints

Flag notifying if vtk’s points should be snap to boundary polygons

Unit: -

isSphericalContact

Weather Spherical Contact [0 : Cylindrical Contact]

Unit: -

lateralAutoCorr

Unit: micron

lateralAxialClearanceBot

Unit: micron

lateralAxialClearanceTop

Lateral Side Body Young’s Modulus

Unit: micron

lateralRoughness

Unit: micron

lateralVarRat

Unit: -

maxCFL

Maximum CFL number for Reynolds films (defaults to 0.5 if not given)

Unit: -

maxSteps

Maximum steps for LSODA

Unit: -

mechTableFile

Location of mechanical file

NOTP

Unit: -

nPtSub

Number of points to evaluate at for sub-atmospheric

Unit: -

NShaftSpeed

Unit: -

nSkipScreen

Print output to screen every nSkipScreen’th print interval (If this isn’t found, simulation sticks to default value of 1)

Unit: -

nSubSteps

Number of of substeps in between printing interval (for taking smaller steps than you want to print, defaults to 1 if not given)

Unit: -

nTeeth

Number of displacement chambers = number of teeth of the outer gear

Unit: -

Ntheta

Grid points in theta direction

Unit: -

nuGas

Gas kinematic viscosity

Unit: mm 2 /s

nuVap

Vapor kinematic viscosity

Unit: mm 2 /s

outerJournalPolygon

Lateral gap tooth profiles

outerLateralPolygon

Lateral gap tooth profiles

outerRotorPolygon

Lateral gap tooth profiles

outletOrifD

Outlet Port Hydraulic Diameter

Unit: mm

outletp

Outlet Pressure

Unit: bar

outletT

Outlet Temperature

Unit: degC

outletVolume

Outlet Volume

Unit: cm 3

PMtype

Prime mover type flag:

  • 1 - Constant torque operation (shaftTorque)

  • 2 - Torque(t) specified with table (motorTorqueFile)

  • 3 - Constant speed operation (shaftSpeed0)

  • 4 - omega = omega(t) specified with table (motorOmegaFile)

Unit: -

PoissonDrive

Drive Gear Poisson Ratio

Unit: -

PoissonDriven

Driven Gear Poisson Ratio

Unit: -

PoissonJbBodyDrive

Unit: -

PoissonJbBodyDriven

Unit: -

PoissonLateral

Unit: -

pVapH

High Vapor pressure

Unit: bar_a

pVapL

Low Vapor pressure

Unit: bar_a

rCut

Driven Gear Cutting radius

Unit: mm

resultsFile

Location to print the output results to

rhoGas

Gas density at reference state

Unit: kg/m 3

rhoVap

Vapor density at reference state

Unit: kg/m 3

rMaxDrive

Drive Gear Max radius

Unit: mm

rMinDriven

Drive Gear minimum radius

Unit: mm

rotorTSVPolygon

Lateral gap tooth profiles

rTolConv

Relative convergence tolerance based on current value. Used in convergence tolerance equation as:

\(error \leq |y_i|*rTolConv + |y_{char_i}|*aTolConv\)

Default: 1e-5 Unit: -

shaftSpeed0

Initial shaft speed (for all cases but 4)

Unit: rev/min

shaftTilting

Conversion to logical decides whether shaft tilting is allowed. (If this isn’t found, simulation allows tilting only for helical gears)

Unit: -

startPrint

Time to start to print

Unit: s

stepOTP

Unit: bar

stepShaftSpeed

Unit: rev/min

suctionPortPolygon

Lateral gap tooth profiles

TensileStrengthDrive

Drive Gear Tensile Strength

Unit: MPa_a

TensileStrengthDriven

Driven Gear Tensile Strength

Unit: MPa_a

TensileStrengthJbBodyDrive

Unit: MPa_a

TensileStrengthJbBodyDriven

Unit: MPa_a

TensileStrengthLateral

Unit: MPa_a

trappedAirVolFract

Trapped air volume percentage

Unit: %

V0

Unit: cm 3 /rev

vtkFilePath

Path for saving vtk film files

writePrec

Decimal precision to print for each value in output files (defaults to ofstream’s default of 9 if not found)

Unit: -