EGM inputDict Definition

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

absRoughnessOutletLine

Absolute roughness of outlet line.

Default: 45 (steel pipe) Unit: micron

angSpanJBDuctDrive

Span of the drive side journal bearing feeding groove (Positive implies in counter clockwise direction)

Unit: rad

angSpanJBDuctDriven

Span of the driven side journal bearing feeding groove (Positive implies in counter clockwise direction)

Unit: rad

angStartHigher

Angular position of the higher edge

Unit:* deg

angStartJBDuctDrive

Start ref:angle <target JournalbearingDims> of the drive side journal bearing feeding groove with respect to the positive x axis (Positive angle indicating clockwise direction)

Unit: deg

angStartJBDuctDriven

Start angle of the driven side journal bearing feeding groove with respect to the positive x axis (Positive angle indicating clockwise direction)

Unit: rad

AOrigCase

Rotation matrix for transformation of influence matrix coordinate system to the casing coordinate system

Unit: -

AOrigPlate

Rotation matrix for transformation of influence matrix coordinate system to the lateral plate coordinate system

Unit: -

AOrigPlateBot

Rotation matrix for transformation of influence matrix coordinate system to the bottom lateral plate coordinate system

Unit: -

AspFrictionCoefJB

Asperity friction coefficient for teflon lined JB

Unit: -

AsymmetricBushingOption

Option to model asymmetric bushing

Unit: -

aTolConv

Absolute convergence tolerance used in convergence tolerance equation as:

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

Default: 1e-5 Unit: -

bearCenter

Center of active region of journal bearing film with respect to the actual center of entire journal bearing

Unit: m

bearingAutoCorr

Autocorrelation length of journal bearing gap interface

Default: 100 microns Unit: m

bearingE1x

Shift of drive journal bearing center from drive casing center in x direction

Default: 0 Unit: mm

bearingE1y

Shift of drive journal bearing center from drive casing center in y direction

Default: 0 Unit: mm

bearingE2x

Shift of driven side journal bearing center from driven casing center in x direction

Default: 0 Unit: mm

bearingE2y

Shift of driven side journal bearing center from driven casing center in y direction

Default: 0 Unit: mm

bearingLinerPoisson

Bearing liner material Poisson ratio

Unit: -

bearingLinerYoungsMod

Bearing liner material Young’s modulus

Unit: MPa_a

bearingRoughness

Equivalent Roughness of the journal bearing interface

Unit: m

bearingTensileStrength

Minimum tensile strength of the materials forming the journal bearing interface

Default: Steel tensile strength Unit: Pa_a

bearingVarRat

Variance ratio of the journal bearing interface = (sigma_top^2 - sigma_bot^2)/(sigma_top^2 + sigma_bot^2)

Default: 0 Unit: -

betaRayleighCaseFilm

Evaluation of Rayleigh damping coefficient for evaluation of casing deformation

Unit: s

betaRayleighJB

Evaluation of Rayleigh damping coefficient for evaluation of journal bearing deformation

Unit: s

betaRayleighLat

Evaluation of Rayleigh damping coefficient for evaluation of lateral plate deformation

Unit: s

betaRayleighPercent

Percentage of Rayleigh damping applied to deformation computation

Unit: %

bfgArea

Cross-sectional area of the backflow groove (pressurization groove) orifice that connects two TSVs together.

Default: $bfgWidth*bfgDepth Unit: m ²

bfgDepth

Depth of the pressurization groove

Unit: mm

bfgHD

Backflow groove hydraulic diameter

Unit: m

bfgVol

Pressurization groove (backflow groove) volume Evaluated using CAD

Unit: mm ³

bfgWidth

Radial width of the pressurization groove

Unit: mm

bmWallOutletLine

Bulk modulus of the outlet line material.

Default: 139 (steel) Unit: GPa_a

BotHPBalanceArea

Area of the high pressure balance area on bottom bushing balance side

Unit: mm ²

BotHPBalanceCPx

X coordinate of the centroid of the high pressure balance area on bottom bushing balance side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

BotHPBalanceCPy

Y coordinate of the centroid of the high pressure balance area on bottom bushing balance side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: mm

BotHPGrooveArea

Area of the high pressure relief groove on bottom bushing gear side

Unit: mm ²

BotHPGrooveCPx

X coordinate of the centroid of the high pressure relief groove on bottom bushing gear side

Unit: mm

BotHPGrooveCPy

Y coordinate of the centroid of the high pressure relief groove on bottom bushing gear side

Unit: mm

BotHSPocketDrArea

Area of the drive side high pressure pockets on bottom bushing gear side

Unit: mm ²

BotHSPocketDrCPx

X coordinate of the centroid of the drive side high pressure pockets on bottom bushing gear side

Unit: mm

BotHSPocketDrCPy

Y coordinate of the centroid of the drive side high pressure pockets on bottom bushing gear side

Unit: m

BotHSPocketSlArea

Area of the driven side high pressure pockets on bottom bushing gear side

Unit: m ²

BotHSPocketSlCPx

X coordinate of the centroid of the driven side high pressure pockets on bottom bushing gear side

Unit: m

BotHSPocketSlCPy

Y coordinate of the centroid of the driven side high pressure pockets on bottom bushing gear side

Unit: m

BotLatAxialClearance

Axial clearance of bottom lateral plate with respect to the casing (evaluated based on tolerances in axial direction using CAD)

Unit: m

BotLPBalanceArea

Area of the low pressure balance area on bottom bushing balance side

Unit: m ²

BotLPBalanceCPx

X coordinate of the centroid of the low pressure balance area on bottom bushing balance side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

BotLPBalanceCPy

Y coordinate of the centroid of the low pressure balance area on bottom bushing balance side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

BotLPGrooveArea

Area of the low pressure relief groove on bottom bushing gear side

Unit: m ²

BotLPGrooveCPx

X coordinate of the centroid of the low pressure relief groove on bottom bushing gear side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

BotLPGrooveCPy

Y coordinate of the centroid of the low pressure relief groove on bottom bushing gear side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

BotPlateFrictCoef

Static friction coefficient for Stribeck friction evaluation between bottom side casing and bushing/plate

Unit: -

BotPlateIxx

Bottom plate moment of inertia about x axis

Unit: kg*m ²

BotPlateIyy

Bottom plate moment of inertia about y axis

Unit: kg*m ²

BotPlateIzz

Bottom plate moment of inertia about z axis

Unit: kg*m ²

BotPlateMass

Mass and moment of inertia evaluations of the bottom lateral plate (Moment of inertia are evaluated by multiplying the area moment of inertia value obtained from CAD with mass)

Unit: kg

BotPlatePoisson

Poisson ratio of the material of the bottom lateral bushing

Default: 0.3 Unit: -

BotPlateRadius

Outer radius of the bottom lateral bushing/plate

Unit: m

BotPlateThickness

Axial thickness of the bottom lateral plate/bushing

Unit: m

BotPlatevBreak

Breaking velocity of bottom lateral plate for Stribeck friction evaluation at casing-bushing interface

Unit: m/s

BotPlateYoungsMod

Bottom Lateral plate material Young’s modulus

Unit: MPa_a

BotSealBalanceArea

Area of the bottom bushing balance side seal

Unit: mm ²

BotSealBalanceCPx

X coordinate of the centroid of the bottom bushing balance side seal

Unit: mm

BotSealBalanceCPy

Y coordinate of the centroid of the bottom bushing balance side seal

Unit: m

BotSealPercHP

High pressure percentage area of the bottom bushing seal

Unit: %

BottomCasingBushingFilms

Flag to check if bottom side casing bushing films are modeled without mirroring

Default: 0 (Bottom Casing bushing films mirrored) Unit: -

bunsenCoef

Bunsen coefficient of the liquid. The Bunsen coefficient is defined as the volume of gas reduced to 273.l5 K and 1 atmosphere pressure which is absorbed by unit volume of solvent (at the temperature of measurement) under a partial pressure of 1 atmosphere.

Unit: -

caseAngNom

Drive gear side casing start angle with respect to the x axis (horizontal axis) from CAD (+rotation indicating in clockwise direction with respect to positive x axis) Overridden if drive side casing file is given

Unit: deg

caseAutoCorr

Autocorrelation length of lateral gap interface

Default: 100 microns Unit: m

CaseClear

Clearance of the casing bushing interface

Unit: m

casePoisson

Poisson ratio of the casing

Unit: -

caseRoughness

Roughness of the casing bushing interface

Unit: Ra_micron

caseTensileStrength

Tensile strength of the casing

Unit: Pa_a

caseVarRat

Variance of the casing bushing interface

Unit: -

CaseYoungsMod

Young’s modulus of the casing

Unit: GPa_a

casingBushClear

Radial clearance between the casing and the bearing block (Should be set as 0 if there is no bearing block and instead a lateral balancing plate is present)

Default: 0 Unit: micron

casingPrec

Resolution of worn casing files

Default: 0.1 Unit: deg

casingtoothClearance

Clearance between gear tooth tip and the casing

Unit: mm

cavType

Specifies the type of cavitation model used.

0 - Static cavitation
1 - Dynamic cavitation

Default: 0 Unit: -

CBforceAprox

Evaluation of approximated force acting on the top face of bearing block for the casing-bushing deformation relation If this value is not present, the force is equated to zero This value is evaluated as approximately the net force acting in Y-direction on gears

Default: 0 Unit: N

cdCasing

Distance between the drive side casing center and driven side casing center

Unit: mm

cellAspJB

Aspect ratio of cells for journal bearing

Default: 1.0 Unit: -

cellAspLat

Aspect ratio of cells for lateral gap

Default: 1 Unit: -

clearBear

Nominal radial clearance at journal bearing

Unit: micron

coastAngle

Coast side angle Between TSV center and the next tooth tip

Unit: deg

cqMax

Max discharge coefficient for orifice connections

Default: 0.7 Unit: -

cqMaxMesh

Max discharge coefficient for meshing zone (FG/CL)

Default: 0.7 Unit: -

dampMesh

Damping coefficient for penetrative contact model in the meshing zone

Unit: -

deg2time

A constant to convert degrees to time.

Default: $PI/180/abs(shaftSpeed0) Unit: -

delHFact

Allowed percent change in gap height over a single explicit step

Unit: %

delHfilmCase

Allowed percent change in casing bushing film gap height over a single explicit step

Unit: m

delHfilmJB

Allowed percent change in journal bearing gap height over a single explicit step

Unit: m

delHfilmLat

Allowed change in gap height of lateral film over single explicit step

Unit: m

deltaAngle

Adjusting the angle based on if the EGM is pumping or motoring (For four quadrant machines) The main contact happens at drive flank if outlet pressure is higher than inlet pressure, the main contact happens at coast flank if inlet pressure is higher than outlet pressure

Unit: rad

deltaAngleDrive

Delta angle between drive and slave gears

Unit: deg

deltaAnglePoly

Rotation matrix for Unit/coordinate system conversion for input driven gear STL with respect to driven gear body coordinate system origin

Unit: rad

delVFact

Allowed percent change in gap velocity over a single explicit step

Unit: -

delVfilmCase

Allowed percent change in casing bushing film gap velocity over a single explicit step

Unit: m

delVfilmJB

Allowed percent change in journal bearing gap velocity over a single explicit step

Unit: m

delVfilmLat

Allowed change in gap velocity of lateral film over single explicit step

Unit: m

diamDrain

Diameter of drain chamber (on lateral side of gears and bearing block)

Unit: mm

diamInletLine

Inlet Line Diameter

Unit: in

diamOutletLine

Inner diameter of the outlet line.

Unit: mm

diamShaft

Diameter of gear shafts

Unit: mm

drainPortA

Drain port orifice connection area (Use in case there is separate drain port present in the machine)

Unit: mm ²

drainPortD

Drain port orifice connection hydraulic diameter (Use in case there is separate drain port present in the machine)

Unit: mm

drainVolume

Drain chamber volume (Use in case there is separate drain port present in the machine)

Unit: mm ³

driveCaseEnd

Drive gear side casing end angle with respect to the x axis (horizontal axis) (+rotation indicating in clockwise direction with respect to positive x axis) Overridden if drive side casing file is given

Unit: rad

driveCaseR

Nominal radius of drive side casing Overridden if drive side casing file is given

Unit: m

driveCaseStart

Drive gear side casing start angle with respect to the x axis (horizontal axis) actual

Unit: rad

driveGearPolygonAllBot

Drive gear polygon for snapping bottom side

driveGearPolygonAllTop

Drive gear polygon for snapping

driveGearPolygonBot

Drive gear polygon bottom side

driveGearPolygonTop

Drive gear polygon

driveGearSTL

Location of STL files of for visualizing different bodies in the EGM. STL path for drive gear

driveHPcase2Poly

Drive side high pressure casing bushing polygon 2

driveHPcasePoly

Drive side high pressure casing bushing polygon 1

driveLPcasePoly

Drive side low pressure casing bushing polygon

drivenCaseEnd

Driven gear side casing end angle with respect to the x axis (horizontal axis) (+rotation indicating in counterclockwise direction with respect to positive x axis) Overridden if driven side casing file is given

Unit: rad

drivenCaseR

Nominal radius of driven side casing Overridden if driven side casing file is given

Unit: m

drivenCaseStart

Driven gear side casing start angle with respect to the x axis (horizontal axis) (+rotation indicating in counterclockwise direction with respect to positive x axis) Overridden if driven side casing file is given

Unit: rad

drivenGearPolygonAllBot

Driven gear polygon for snapping bottom side

drivenGearPolygonAllTop

Driven gear polygon for snapping

drivenGearPolygonBot

Driven gear polygon bottom side

drivenGearPolygonTop

Driven gear polygon

drivenGearSTL

STL path for driven gear

drivenTSPolygonBot

Driven gear tooth space volume polygon bottom side

drivenTSPolygonTop

Driven gear tooth space volume polygon

driveTSPolygonBot

Drive gear tooth space volume polygon bottom side

driveTSPolygonTop

Locations of polygon files which are used to specify boundary conditions for reynolds film solution of lateral film which is formed between lateral bushing/plate and lateral surface of gears. More details regarding these files and what they indicate can be found in polygon file generation section of the EGM tutorial. Drive gear tooth space volume polygon

dualFlankInterx

Dual flank interaxis distance of gears

Unit: mm

EgapBearing

Effective gap Young’s modulus of the journal bearing gap for micro-deformation

Unit: Pa_a

EgapCaseFilm

Effective Young’s modulus of the casing

Unit: Pa_a

EgapLateral

Effective Young’s modulus of the lateral gap for micro-deformation evaluations

Unit: Pa_a

endPrint

Time to end simulation. Use rev2time to set a number of revolutions.

Default: 2*rev2time Unit: s

estVolEff

Estimated volumetric efficiency.

Default: 90.0 Unit: %

filmSolverJB

Type of solver used to solve the journal bearing fluid film.

Inputs:

0 - Default for film type
1 - Explicit single step
2 - Explicit multi-step
-1 - Implicit single step
-2 - Implicit multi-step

Default: -1 Unit: -

filmSolverLat

Type of solver used to solve the lateral fluid film.

Inputs:

0 - Default for film type
1 - Explicit single step
2 - Explicit multi-step
-1 - Implicit single step
-2 - Implicit multi-step

Default: -1 Unit: -

finalcasingDrive

Path and name of file where the drive side (Gear 1) casing wear is written.

finalcasingDriven

Path and name of file where the driven side (Gear 2) casing wear is written.

fluidPropSub

Location of fluid property files sub atmospheric data. This input is on required if fluidType=0.

fluidPropSuper

Location of fluid property files super atmospheric data.

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: -

gammaMesh

Limiting shear strength proportionality constant of the working fluid (Typically between 0.05 to 0.1 for hydraulic oils)

Unit: -

gammaVap

Vapor polytropic index

Unit: -

gapBearingIsLined

Flags notifying if journal bearing gaps contain ductile liners or not

Unit: -

gapCaseFilmIsLined

Flag to check if the casing bushing gap is lined

Unit: -

gapLateralIsLined

Flags notifying if the lateral gap contains ductile liners

Unit: -

gear1Ixx

Gear 1 moment of inertia about x axis (The area moment of inertia can be estimated using CAD software and multiplied with mass to obtain the mass moment of inertia)

Unit:* kg*m ²

gear1Iyy

Gear 1 moment of inertia about y axis (The area moment of inertia can be estimated using CAD software and multiplied with mass to obtain the mass moment of inertia)

Unit:* kg*m ²

gear1Izz

Gear 1 moment of inertia about z axis (The area moment of inertia can be estimated using CAD software and multiplied with mass to obtain the mass moment of inertia)

Unit:* kg*m ²

gear1Mass

Gear 1 (drive gear mass)

Unit: kg

gear2Ixx

Gear 2 moment of inertia about x axis (The area moment of inertia can be estimated using CAD software and multiplied with mass to obtain the mass moment of inertia)

Unit:* kg*m ²

gear2Iyy

Gear 2 moment of inertia about y axis (The area moment of inertia can be estimated using CAD software and multiplied with mass to obtain the mass moment of inertia)

Unit:* kg*m ²

gear2Izz

Gear 2 moment of inertia about z axis (The area moment of inertia can be estimated using CAD software and multiplied with mass to obtain the mass moment of inertia)

Unit:* kg*m ²

gear2Mass

Gear 2 (driven gear) mass

Unit: kg

gearDensity

Gear material density

Unit: g/cm ³

gearE1x

Initial eccentricity of drive gear at journal bearing in x direction

Default: 0 Unit: mm

gearE1y

Initial eccentricity of drive gear at journal bearing in y direction

Default: 0 Unit: mm

gearE2x

Initial eccentricity of driven gear at journal bearing in x direction

Default: 0 Unit: mm

gearE2y

Initial eccentricity of driven gear at journal bearing in y direction

Default: 0 Unit: mm

GearPoisson

Gear/shaft Poisson ration

Default: 0.3 Unit: -

GearYoungsMod

Gear/shaft Young’s modulus (for calculation of analytical macro-deformation)

Default: 0 ( Corresponds to no deformation) Unit: MPa_a

geometryTableFile

Location of the geometry file Definition: The geometry file for external gear machines stores the variation of different important features of the EGM with the angle of rotation of drive gear. These features include orifice connection areas and hydraulic diameters, projection areas of tooth space volumes along different coordinate systems etc. More details can be found in geometry generation section of the EGM tutorial.

h3effJBDuctDrive

Effective gap height at the drive side feeding duct

Unit:* m ³

h3effJBDuctDriven

Effective gap height at the driven side feeding duct

Unit:* m ³

helixShift

Helix Shift From Top to Bottom Face (+ means bottom face leads the top face, for helical gears)

Unit: deg

hHigher

Gap height at the higher edge

Unit:* mm

hLatBot

Initial lateral gap height between the lateral surface of gears and the balancing elements at bottom surface of gears Assumed same as the top side value

Unit: m

hLatTop

Initial lateral gap height between the lateral surface of gears and the balancing elements at top surface of gears

Unit: micron

hLower

Evaluation of effective gap height at journal bearing feeding duct Gap height at the lower edge

Unit:* mm

HSGrooveDrivenPolygonBot

Driven side high speed groove polygon bottom side

HSGrooveDrivenPolygonTop

Driven side high speed groove polygon

HSGrooveDrivePolygonBot

Drive side high speed groove polygon bottom side

HSGrooveDrivePolygonTop

Drive side high speed groove polygon

HSGrooveOption

Model option choice for HS groove

Inputs:

0 - adjacent TSVs are connected through HS groove (HSadj)
1 - TSVs connected to the outletchamber through HS groove (HSoutlet)
2 - TSVs connected to the HS pocket chamber on the bearing block through HS groove (HSpocket)

Default: -0 Unit: -

inletGroovePolygonBot

Inlet relief groove polygon bottom side

inletGroovePolygonTop

Inlet relief groove polygon

inletLineMinorLossCoef

Minor loss coefficient at the inlet line. Losses at the entrance and the exit of the line.

Unit: -

inletp

Constant inlet tank pressure.

Default: 0 Unit: bar

inletPolygonBot

Inlet chamber connection polygon bottom side

inletPolygonTop

Inlet chamber connection polygon

inletPortA

Cross-Sectional Area of the inlet port

Default: $pi/4*inletPortD^2 Unit: mm ²

inletPortD

Inlet Port Hydraulic Diameter Definition: The equivalent diameter of the inlet port of the pump

Unit: mm

inletT

Constant inlet tank temperature.

Unit: degC

inletTankHeight

Change in height from the inlet tank to the inlet of the pump. A positive value means that the location of the tank is higher compared to the pump.

Unit: ft

inletVolume

Volume of the inlet chamber of the EGM (Calculated from the CAD, Refers to the volume not considered in the tooth space volumes in geometry file generator)

Unit:* cm ³

integratorType

Type of integrator used to solve the system of equations.

Inputs:

1 - LSODA integrator
2 - Runge Kutta
3 - Adams Bashforth/Moulton Predictor Corrector

Default: 1 Unit: -

interaxisPoly

Nominal interaxis distance (between axis of drive and driven gear shafts) for locating the polygons for lateral film calculations

Default: $cdCasing Unit: m

intvPrint

Interval to print to results file.

Unit: s

isBotPlateDef

Unit: -

isBotPlateMacroDef

Flag notifying if the bottom lateral plate/bushing macro-deformation is solved analytically (Solved using cantilever beam deformation)

Unit: -

isBotPlateMoving

Flag notifying if the bottom lateral plate/bushing is allowed to move in axially in z direction

Unit: -

isBotPlateTilting

Flag notifying if the bottom lateral plate/bushing is allowed to tilt about x and y axes

Unit: -

isCaseDef

Flag to notify if casing is deforming using influence matrix

Unit: -

isCaseFilmMicroDef

Flag notifying that the Casing bushing film micro deformation is to be solved for

Unit: -

isCaseFilmMixed

Flag notifying that the Casing bushing film mixed lubrication is to be solved for

Unit: -

isCasingBushingFilms

Flag to model casing bushing films

Default: 0 (Casing bushing films not modeled) Unit: -

isGearMacroDef

Flag notifying if the analytical macro-deformation of gears is solved (The deformation is calculated analytically using Euler Bernoulli Beam Theory)

Unit: -

isGearMeshPen

Flag notifying if the penetration of gears at the meshing is solved (Changes how the contact force and friction forces at meshing interface are calculated)

Unit: -

isGearMovingXY

Flag notifying if the gears are allowed to move linearly in x-y plane

Unit: -

isGearMovingZ

Flag notifying if the gears are allowed to move axially in z direction

Unit: -

isGearTilting

Flag notifying if the gears are allowed to tilt about x and y axes

Unit: -

isJBanalDefOverrideGear

Unit: -

isJBanalDefOverrideLiner

Unit: -

isJBDef

Unit: -

isJBDefGear

Unit: -

isJBDefLiner

Unit: -

isJBDrainDuct

Option to model journal bearing drain duct

Unit: -

isJBFilmAsperityPolynomial

Flag notifying if the polynomial evaluation of asperity contact pressure is used (Only considered if mixed lubrication is present)

Unit: -

isJBFilmInfMatDefGear

Unit: -

isJBFilmInfMatDefLiner

Unit: -

isJBFilmMicroDef

Unit: -

isJBFilmMicroDefGear

Unit: -

isJBFilmMicroDefLiner

Unit: -

isJBFilmMixed

Unit: -

isJBFilmMixedLubri

Unit: -

isJBFilmSolidFriction

Flag notifying that asperity friction at journal bearings is considered (Only consider if mixed lubrication is present)

Unit: -

isLatFilmMicroDef

Flag notifying if the analytical micro deformation at lateral gap films is to be solved for

Unit: -

isLatFilmMixed

Flag notifying if the mixed lubrication effects at lateral gap films are considered

Unit: -

isPlateDef

Flag notifying how the deformation of top and bottom plate bodies forming the lateral gap films is accounted for.

Unit: -

isPlateMacroDef

Flag notifying if the lateral plate/bushing macro-deformation is solved analytically (Solved using cantilever beam deformation)

Unit: -

isPlateMoving

Flag notifying if the lateral plate/bushing is allowed to move in axially in z direction

Unit: -

isPlateTilting

Flag notifying if the lateral plate/bushing is allowed to tilt about x and y axes

Unit: -

isPrintatOrig

Flag notifying if vtk’s should be print at film origin

Unit: -

isSnapPoints

Flag notifying if vtk’s points should be snap to boundary polygons. This input is useful for generating smooth boundary profiles for visualizing the results.

Unit: -

JBlatLinkOption

Model option choice for journal bearing and lateral gap drain leakage connection

Inputs:

0 - Connect both drain leakages to inlet (default)
1 - Connect drain leakages to a drain chamber which is then connected to inlet or can be isolated
2 - Link the journal bearing and lateral gap flow at the boundary

Default: -0 Unit: -

JournalBearingModel

Model type for journal bearing.

Inputs:

0 - Analytical Film ( Journal bearing solution based on impedance theory)
1 - Reynolds Film (Journal bearing solution using Reynolds equation)

Unit: -

LateralGapModel

Model type for lateral gap.

Inputs:

0 - Analytical Film ( Leakages and torque losses are evaluated by considering a flow between parallel plates)
1 - Reynolds Film ( Solution using Reynolds Equation)

Unit: -

latgapAutoCorr

Autocorrelation length of lateral gap interface

Default: 100 microns Unit: m

latgapRoughness

Equivalent Roughness of the lateral gap

Default: 0 (if lateral gap mixed lubrication is set to false) Unit: m

latgapTensileStrength

Minimum tensile strength of the materials forming the lateral gap interface

Default:* Steel tensile strength Unit:* MPa_a

latgapVarRat

Variance ratio of the lateral gap interfaces = (sigma_top^2 - sigma_bot^2)/(sigma_top^2 + sigma_bot^2)

Default: 0 Unit: -

lenBear

Length of journal bearing active region (Journal bearing film length)

Unit: m

lenBearBore

Length of the entire journal bearing bore including area around liner) This length is same as the axial length of the bearing block if the journal bearings are housed inside the lateral bushing

Unit: mm

lenCase

Axial length of the casing bushing interface film

Unit: mm

lengthDrain

Length of drain chamber (or journal bearing drain length)

Unit: mm

lenInletLine

The inlet line is modeled as a laminar duct Inlet line length.

Unit: mm

lenOutletLine

Length of the outlet line.

Unit: mm

lenSensorOutletLine

Location of the sensors in the outlet line relative to the starting location of the line

Unit: mm

maxCFLCase

CFL value for the casing bushing film interface

Unit: -

maxCFLJB

Maximum CFL number for journal bearing Reynolds films

Default: 0.5 Unit: -

maxCFLLat

Maximum CFL number for lateral gap Reynolds film

Default: 0.5 Unit: -

maxSteps

Maximum number of steps for LSODA. Is this only for lsoda? BLANK

Unit: -

natFreqBearing

Natural frequency of bearing body lowest frequency from modal analysis of gear - fixed constraint at center circle of central slice bore, symmetry through rest of central slice

Unit: Hz

natFreqCase

Natural frequency of the casing Lowest frequency obtained using modal analysis of the casing assuming a fixed constraint at the face close to the mounting side

Unit: Hz

natFreqPlate

Natural frequency of the lateral plate Lowest frequency obtained using modal analysis of the plate assuming a fixed constraint at the low pressure side area of contact between casing and bushing

Unit: Hz

nAxSect

Number of axial sections for equivalent spur gear calculations (in case of helical gears) and for 3d casing calculations in case of deformation considerations

Unit: -

negZTopBear

Location definition of the top edge of the journal bearing film with respect to overall journal bearing center

Unit: mm

nNodeOutletLine

Number of nodes to use for the outlet line.

Unit: -

nPtsMaxBotLat

Number of points maximum for a bottom side lateral gap (single gears)

Unit: -

nPtsMaxCase

Number of maximum mesh points single casing bushing film gap

Unit: -

nPtsMaxJB

Number of maximum mesh points single journal bearing gap

Unit: -

nPtsMaxTopLat

Number of points maximum for a lateral gap (single gears)

Unit: -

nPtSub

Number of points to evaluate sub atmospheric fluid properties using analytical expressions. The data calculated at these points is interpolated based on the pressure. This input is on required if fluidType=1.

Unit: -

nSkipScreen

Prints output to screen every nSkipScreen’th.

Default: 1 Unit: -

nTeeth

Number of teeth of gears

Unit: -

nTeethOrif

The outlet pressure ripple is calculated at the sensor using a moving average. The time frame for the moving average is considered using the number of teeth based on this variable’s value.

Default: 1 Unit: -

nuGas

Gas kinematic viscosity

Unit: mm ² /s

nuVap

Vapor kinematic viscosity, considered to be same as gas kinematic viscosity

Unit: m ² /s

ompNthreads

Number of CPU threads to use for parallel computation.

Unit: -

outerDiamOutletLine

Outer diameter of the outlet line.

Unit: mm

outletGroovePolygonBot

Outlet relief groove polygon bottom side

outletGroovePolygonTop

Outlet relief groove polygon

outletp

Constant outlet tank pressure.

Unit: bar

outletPolygonBot

Outlet chamber connection polygon bottom side

outletPolygonTop

Outlet chamber connection polygon

outletPortA

Cross-Sectional Area of the outlet port

Default: $pi/4*outletPortD^2 Unit: mm ²

outletPortD

Outlet Port Hydraulic Diameter Definition: The equivalent diameter of the inlet port of the pump (for symmetric machines, same as inlet port diameter)

Unit: m

outletT

Constant outlet tank temperature.

Unit: degC

outletVolume

Volume of the outlet chamber of the EGM (Calculated from the CAD, Refers to the volume not considered in the tooth space volumes in geometry file generator, for symmetric machines, same as inletVolume)

Unit:* m ³

pAtmIMCase

Atmospheric pressure where the case body is undeformed

Unit: bar

pAtmIMPlate

Atmospheric pressure where the body is undeformed

Unit: bar

plateDensity

Density of the material of the lateral bushing

Unit: g/cm ³

platePoisson

Poisson ratio of the material of the lateral bushing

Default: 0.3 Unit: -

plateYoungsMod

Lateral plate material Young’s modulus

Unit: MPa_a

PMtype

Prime mover type that describes the drive mechanism.

Inputs:

1 - Constant torque operation shaftTorque
2 - Torque(t) specified with table motorTorqueFile
3 - Constant speed operation shaftSpeed0
4 - Omega(t) specified with table motorOmegaFile

Unit: -

poissonWallOutletLine

Poisson ratio of the outlet line material.

Default: 0.3 (steel) Unit: -

polyCoeffsJBFilm

polynomial coefficients for JB film with steel - bronze contact and surface roughness (Ra) of 1.6 microns for gears and 0.1 microns for JB

Unit: -

polyCoeffsLatFilm

Asperity polynomial coefficients lateral film

Unit: -

posZTopBear

Location definition of the bottom edge of the journal bearing film with respect to overall journal bearing center

Unit: mm

pScaleIMCase

Scaling factor of a pressure applied to the faces during influence matrix generation

Default: 1e-2 m/bar_a Unit: m/Pa_a

pScaleIMPlate

Scaling factor of a pressure applied to the faces during influence matrix generation

Default: 1e-2 m/bar_a Unit: m/bar_a

pVapH

Higher vapor saturation pressure of the fluid. It is the pressure at which the fluid begins to vaporize.

Unit: bar_a

pVapL

Lower vapor saturation pressure of the fluid. It is the pressure at which the vaporize of the fluid is completed.

Unit: bar_a

rBase

Base circle radius of gears

Unit: mm

rCase

Radius of the casing bushing film

Unit: mm

resultsFile

The file to which to write simulation results

rev2time

A constant to convert revolutions to time.

Default: rev2time - $2*PI/abs(shaftSpeed0) Unit: -

rhoGas

Gas density at reference state

Unit: kg/m ³

rhoVap

Vapor density at reference state, considered to be same as gas density

Unit: kg/m ³

rOrigBotPlateSTL

Vector from bottom lateral plate body coordinate system origin to origin in STL coordinate system (after rotation)

Unit: m

rOrigCase

Vector pointing from the influence matrix coordinate system origin to the casing coordinate system origin

Unit: m

rOrigCaseSTL

Vector from casing body coordinate system origin to origin in STL coordinate system (after rotation)

Unit: mm

rOrigDrivenSTL

Vector from driven gear body coordinate system origin to origin in STL coordinate system (after rotation)

Unit: m

rOrigDriveSTL

Vector from drive gear body coordinate system origin to origin in STL coordinate system (after rotation)

Unit: m

rOrigGear

Vector pointing from the influence matrix coordinate system origin to the drive gear coordinate system origin

Unit: m

rOrigPlate

Vector pointing from the influence matrix coordinate system origin to the lateral plate coordinate system origin

Unit: m

rOrigPlateBot

Vector pointing from the influence matrix coordinate system origin to the bottom lateral plate coordinate system origin

Unit: m

rOrigTopPlateSTL

Vector from lateral plate body coordinate system origin to origin in STL coordinate system (after rotation)

Unit: m

roughGearJB

Surface roughness of gear shaft at the journal bearing

Unit: Ra_micron

roughGearLat

Surface roughness of the lateral gap side of the gear

Unit: Ra_micron

roughLinerJB

Surface roughness of journal bearing liner

Unit: Ra_micron

roughPlateLat

Surface roughness of the lateral gap side of the lateral plate bearing

Unit: Ra_micron

rOuterG1T

Outer radius of gears at the top lateral surface (-z direction)

Unit: mm

rRoot

Root radius of gears

Unit: mm

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

Constant input shaft speed for PMtype 3.

Unit: rev/min

shaftSupportPos

Normalized position of support force point at journal bearings for analytical macro-deformation calculation 0% indicates that the force acts exactly at gear facing side of bearing

Default: 50% Unit: %

shaftTorque

Constant shaft torque for PMtype 1.

Unit: N*m

slaveHPcasePoly1

Driven side high pressure casing bushing polygon 1

slaveHPcasePoly2

Driven side high pressure casing bushing polygon 2

slaveHPcasePoly3

Driven side high pressure casing bushing polygon 3

slaveLPcasePoly

Driven side low pressure casing bushing polygon

startCasing

Time to start recording casing wear.

Casing wear should only start after the pressures have converged. If this variable is not found, the casing wear is constantly updated.

Unit: s

startPrint

Simulation time to start printing results to the results file.

Default: 0.0 Unit: s

startPrintCFD

Simulation time to start printing CFD results.

Default: $startPrint Unit: s

tauDefBearing

Time to ease deformation of bearing over

Unit: s

tauDefCase

Time to ease in the deformation of the casing over for numerical stability of lateral film evaluation

Unit: s

tauDefPlate

Time to ease in the deformation of the lateral plate over for numerical stability of lateral film evaluation

Unit: s

theorDisp

Theoretical displacement of pump. This value can be found in the data sheet or can be calculated using geometry table.

Unit: cm ³ /rev

thickOutletLine

Thickness of the outlet line.

Default: $(outerDiamOutletLine - diamOutletLine)/2.0 Unit: m

tipWidth

Tooth tip width for radial leakage evaluation (used in laminar leakage calculation by considering the flow between parallel plates at the tooth tips)

Unit: mm

toothWidth

Tooth Width for lateral leakage evaluation (used in laminar leakage calculation by considering the flow between parallel plates at the lateral interface between gears and balancing plates)

Unit: mm

TopHPBalanceArea

Area of the high pressure balance area on balance side

Unit: mm ²

TopHPBalanceCPx

X coordinate of the centroid of the high pressure balance area on balance side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

TopHPBalanceCPy

Y coordinate of the centroid of the high pressure balance area on balance side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: mm

TopHPGrooveArea

Area of the high pressure relief groove on gear side

Unit: mm ²

TopHPGrooveCPx

X coordinate of the centroid of the high pressure relief groove on gear side

Unit: mm

TopHPGrooveCPy

Y coordinate of the centroid of the high pressure relief groove on gear side

Unit: mm

TopHSPocketDrArea

Area of the drive side high pressure pockets on gear side

Unit: mm ²

TopHSPocketDrCPx

X coordinate of the centroid of the drive side high pressure pockets on gear side

Unit: mm

TopHSPocketDrCPy

Y coordinate of the centroid of the drive side high pressure pockets on gear side

Unit: m

TopHSPocketSlArea

Area of the driven side high pressure pockets on gear side

Unit: m ²

TopHSPocketSlCPx

X coordinate of the centroid of the driven side high pressure pockets on gear side

Unit: m

TopHSPocketSlCPy

Y coordinate of the centroid of the driven side high pressure pockets on gear side

Unit: m

TopLatAxialClearance

Axial clearance of lateral plate with respect to the casing (evaluated based on tolerances in axial direction using CAD)

Unit: m

TopLPBalanceArea

Area of the low pressure balance area on balance side

Unit: m ²

TopLPBalanceCPx

X coordinate of the centroid of the low pressure balance area on balance side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

TopLPBalanceCPy

Y coordinate of the centroid of the low pressure balance area on balance side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

TopLPGrooveArea

Area of the low pressure relief groove on gear side

Unit: m ²

TopLPGrooveCPx

X coordinate of the centroid of the low pressure relief groove on gear side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

TopLPGrooveCPy

Y coordinate of the centroid of the low pressure relief groove on gear side (defined with respect to the bushing center of mass in the global coordinate system)

Unit: m

TopPlateFrictCoef

Static friction coefficient for Stribeck friction evaluation between casing and bushing/plate

Unit: -

TopPlateIxx

Top plate moment of inertia about x axis

Unit: kg*m ²

TopPlateIyy

Top plate moment of inertia about y axis

Unit: kg*m ²

TopPlateIzz

Top plate moment of inertia about z axis

Unit: kg*m ²

TopPlateMass

Mass and moment of inertia evaluations of the lateral plate (Moment of inertia are evaluated by multiplying the area moment of inertia value obtained from CAD with mass)

Unit: kg

TopPlateRadialClearance

Geometric Radial clearance of plate with respect to casing

Unit: micron

TopPlateRadius

Outer radius of the lateral bushing/plate

Unit: m

TopPlateThickness

Axial thickness of the lateral plate/bushing

Unit: m

TopPlatevBreak

Breaking velocity of lateral plate for Stribeck friction evaluation at casing-bushing interface

Unit: m/s

TopSealBalanceArea

Area of the balance side seal

Unit: mm ²

TopSealBalanceCPx

X coordinate of the centroid of the balance side seal

Unit: mm

TopSealBalanceCPy

Y coordinate of the centroid of the balance side seal

Unit: m

TopSealPercHP

High pressure percentage area of the seal

Unit: %

trappedAirVolFract

Trapped air volume percentage

Unit: %

unitConvBotPlateSTL

Rotation matrix for Unit/coordinate system conversion for input bottom lateral plate STL with respect to lateral plate body coordinate system origin

Unit: mm

unitConvCaseSTL

Rotation matrix for Unit/coordinate system conversion for casing STL with respect to casing body coordinate system origin

Unit: mm

unitConvDrivenSTL

Final matrix for coordinate system conversion for input driven gear STL with respect to driven gear body coordinate system origin

Unit: m

unitConvDriveSTL

Rotation matrix for Unit/coordinate system conversion for input drive gear STL with respect to drive gear body coordinate system origin

Unit: mm

unitConvTopPlateSTL

Rotation matrix for Unit/coordinate system conversion for input lateral plate STL with respect to lateral plate body coordinate system origin

Unit: mm

uScaleDrive

Scaling of driven gear STL coordinate system linear unit

Unit: mm

vtkFilePath

Path for saving vtk files for visualization of Reynolds films.

wholeDepth

Depth of Tooth space volume or gear’s whole depth in axial (z) direction

Unit: mm

writePrec

Decimal precision to print for each value in output files

Default: 9 Unit: -