APM inputDict Definition
This is a list of all the variables in the tutorial APM template. Check out this page for more details on the units.
areaTableIn case pressure build up is solved for, the area table is to be given as an input
betaSwashplate Angle
Unit: deg
betaMaxMaximum swashplate angle
Unit: deg
blockDensityBlock density
Unit: kg/m 3
blockDirichletSetBlock dirichlet boundary sets
Unit: -
blockDirichletTempBlock dirichlet boundary temperatures
Unit: degC
blockElementSetBlock volume sets and associated material properties
Unit: -
blockFactorBlock factor
Unit: -
blockFilmFrictionCoefficientBlock film asperity friction coefficient
Unit: -
blockIMDirBlock influence Matrix directory
blockIxxBlock Ixx at crowning point
Unit: kg*m 2
blockIyyBlock Iyy at crowning point
Unit: kg*m 2
blockIzzBlock Izz at crowning point
Unit: kg*m 2
blockMassBlock mass
Unit: kg
blockMeshBlock thermal mesh file
blockMixedCoeffBlock mixed boundary fluxes
Unit: W/m 2 /K
blockMixedSetBlock mixed boundary sets
Unit: -
blockMixedTempBlock mixed boundary temperature
Unit: degC
blockNeumannFluxBlock neumann boundary fluxes
Unit: W/m 2
blockNeumannSetBlock neumann boundary sets
Unit: -
blockSetConductivityCorresponding thermal conductivities
Unit: W/m/K
blockSetDensityCorresponding densities
Unit: kg/m 3
blockSetElasticModCorresponding young’s moduli
Unit: GPa_a
blockSetExpansionCoeffCorresponding thermal expansion coefficients
Unit: -
blockSetPoissonCorresponding poisson’s ratios
Unit: -
blockSTLBlock STL for printing bodies
chmbrAPolyPolygon file for outlet chamber
chmbrBPolyPolygon file for inlet chamber
dBoreDiameter of bushing
Unit: mm
dcPolyPolygon file for displacement chamber
degPrintPrint interval in degrees
Unit: deg
degStartRelaxBodyWhat shaft angle to start applying relaxation on body motion
Unit: deg
degStopRelaxBodyWhat shaft angle to start applying relaxation on body motion
Unit: deg
dInBlockInner radius of block running surface (vp film)
Unit: mm
dInSlipperSlipper inner radius
Unit: mm
dOutBlockInner radius of block running surface (vp film)
Unit: mm
dOutSlipperSlipper outer radius
Unit: mm
dPistonDiameter of piston
Unit: mm
dPitchPitch radius
Unit: mm
dySpRotY offset of the swashplate rotation center at zero displacement
Unit: mm
dzBlockCGZ offset from ideal crowning point point to block CG
Unit: mm
dzBlockRunZ distance between origin and block/valveplate running surface at zero displacement
Unit: mm
dzBoreRunSurfBushing running surface center on block from ref(positive sense from vp to sp) ref - Origin
Unit: mm
dzCrownZ distance between origin and shaft reaction point on block at zero displacement
Unit: mm
dzPistonCGZ offset from ball center to piston CG
Unit: mm
dzPistonFlatBallPiston flat end from ball head
Unit: mm
dzPistonRunSurfPiston running surface center from ball head(positive sense from vp to sp)
Unit: mm
dzSlipCGZ offset from socket center to slipper CG
Unit: mm
dzSlipRunSlipper running surface from socket center
Unit: mm
dzSpRotZ offset of the swashplate rotation center at zero displacement
Unit: mm
EBlockBlock Young’s modulus
Unit: GPa_a
EBushingBushing Young’s modulus
Unit: GPa_a
EPistonPiston Young’s modulus
Unit: GPa_a
ESlipperSlipper Young’s modulus
Unit: GPa_a
ESwashplateSwashplate Young’s modulus
Unit: GPa_a
EVPVP Young’s modulus
Unit: GPa_a
FilmMaxTimeStepMaximum time step for a lubricating film (optional, user can keep blank and it will stick to default)
Unit: s
filmStepMaxGrowthMaximum growth of film time steps
Unit: %
fluidPropSubLocation of sub atmospheric fluid property file
fluidPropSuperLocation of super atmospheric fluid property file
fluidType- Fluid properties type
0 - Fluid Props Sub/Super with cavitation integrated in files 1 - Single fluid props super with cavitation specified 2 - User expression with cavitation specified
Unit: -
FSlipperHoldDownSlipper Hold down force
Unit: N
FSpringBlockBlock Spring force
Unit: N
hBlock_casinginnerBlock heat transfer coefficient to inner casing fluid
Unit: W/m 2 /K
hBlock_casingouterBlock heat transfer coefficient to inner casing fluid
Unit: W/m 2 /K
hBlock_dcBlock heat transfer coefficient to displacement chamber fluid
Unit: W/m 2 /K
hBlock_groovebearingBlock heat transfer coefficient to inner casing fluid
Unit: W/m 2 /K
hBlock_outerbearingBlock heat transfer coefficient to inner casing fluid
Unit: W/m 2 /K
hInitBlockFilmInitial film thickness on block Film
Unit: micron
hInitSlipperFilmInitial film thickness on slipper Film
Unit: micron
hPiston_ballPiston heat transfer coefficient to casing fluid through ball joint
Unit: W/m 2 /K
hPiston_casePiston heat transfer coefficient to casing fluid through casing surface
Unit: W/m 2 /K
hPiston_dcPiston heat transfer coefficient to displacement chamber fluid
Unit: W/m 2 /K
hSlipper_caseSlipper heat transfer coefficient to casing fluid through casing surface
Unit: W/m 2 /K
hSlipper_pocketSlipper heat transfer coefficient to pocket fluid
Unit: W/m 2 /K
hSlipper_socketSlipper heat transfer coefficient to casing fluid through ball joint
Unit: W/m 2 /K
hSP_casingSwashplate heat transfer coefficient to casing
Unit: W/m 2 /K
hVP_casingValveplate heat transfer coefficient to casing
Unit: W/m 2 /K
hVP_hpValveplate heat transfer coefficient to outlet chamber in casing
Unit: W/m 2 /K
hVP_lpValveplate heat transfer coefficient to inlet chamber in casing
Unit: W/m 2 /K
hVP_outerbearingValveplate heat transfer coefficient to casing
Unit: W/m 2 /K
impContrImpedance contribution threshold
Unit: %
impContrHardImpedance contribution hard threshold
Unit: %
impShrinkRateImpedance shrink rate
Unit: -
IntegratorAbsTol- The following two correspond to convergence tolerance, evaluated as:
error_i<=tol_i=|y_i|*rTol + |y_char,i|*aTol
Absolute tolerance for the integrator
Unit: -
IntegratorMaxStepsMaximum steps for the integrator (optional, user can keep blank and it will stick to default)
Unit: -
IntegratorMaxTimeStepMaximum time step for the integrator (optional, user can keep blank and it will stick to default)
Unit: s
IntegratorRelTolRelative tolerance for the integrator
Unit: -
isBlockFilmWhether to solve for the cylinder block film
Unit: -
isBoreProfileWhether to consider surface profile on bore
Unit: -
isDefBlockFilmWhether to consider deformation in the block film 0 - no deformation, 1 - analytical micro deformation, 2 - influence matrix
Unit: -
isDefPistonFilmWhether to consider deformation in the piston film 0 - no deformation, 1 - analytical micro deformation, 2 - influence matrix
Unit: -
isDefSlipperFilmWhether to consider deformation in the slipper film
Unit: -
isEnergyEqFilmsWhether to solve energy equation in lubricating interfaces
Unit: -
isMixedLubBlockFilmWhether to consider mixed lubrication in the block film
Unit: -
isMixedLubPistonFilmWhether to consider mixed lubrication in the piston film
Unit: -
isMixedLubSlipperFilmWhether to consider mixed lubrication in the slipper film
Unit: -
isPistonFilmWhether to solve for piston film
Unit: -
isPistonProfileWhether to consider surface profile on piston
Unit: -
isPrintBodyFlag notifying if bodies are to be printed
Unit: -
isSlipperFilmWhether to solve for slipper film
Unit: -
isSlipperProfileWhether to consider surface profile on slipper
Unit: -
isSolidHeatTransferSolid body heat transfer
Unit: -
isThermalDeformationSolid body thermal deformation
Unit: -
lBoreRunSurfBushing running surface length
Unit: mm
lPistonRunSurfPiston running surface length
Unit: mm
maxCFLMaximum CFL for films
Unit: -
muPistonSocketDynDynamic friction coefficient of the ball-socket joint
Unit: -
muPistonSocketStatStatic friction coefficient of the ball-socket joint
Unit: -
natFreqBlockNatural frequency of block
Unit: Hz
natFreqPistonNatural frequency of Piston
Unit: Hz
natFreqSlipperNatural frequency of Slipper
Unit: Hz
natFreqSwashplateNatural frequency of Swashplate
Unit: Hz
natFreqVPNatural frequency of VP
Unit: Hz
nDegDefInitDegree till which influence matrices are not applied
Unit: deg
nDegThermalCalcDegrees at which solid temperature to be updated
Unit: deg
nDegThermalSampleDegree interval at which heat flux is to be sampled
Unit: deg
nPistonNumber of pistons
Unit: -
nPtsBlockFilmNumber of points on block film
Unit: -
nPtsPistonFilmNumber of points on piston film
Unit: -
nPtsSlipperFilmNumber of points on slipper film
Unit: -
nRevNumber of revolutions to run
Unit: -
nRevFluxRelaxNumber of revolutions till which the heat flux from the interfaces are to be relaxed
Unit: -
nuBlockBlock Poisson’s ratio
Unit: -
nuBushingBushing Poisson’s ratio
Unit: -
nuPistonPiston Poisson’s ratio
Unit: -
nuSlipperSlipper Poisson’s ratio
Unit: -
nuSwashplateSwashplate Poisson’s ratio
Unit: -
nuVPVP Poisson’s ratio
Unit: -
omegaShaft speed
Unit: rev/min
ompNthreadsNumber of threads for parallel implementation
Unit: -
outputListFileLocation to write output availability table (if this entry doesn’t exist, no file written)
pA+x port side pressure
Unit: bar
pB-x port side pressure
Unit: bar
pCaseCase pressure
Unit: bar
percDampDefBlockPercentage damping on block deformation
Unit: %
percDampDefPistonPercentage damping on block deformation
Unit: %
percDampDefSlipperPercentage damping on block deformation
Unit: %
percDampDefSwashplatePercentage damping on block deformation
Unit: %
percDampDefVPPercentage damping on block deformation
Unit: %
pistonDensityPiston density
Unit: kg/m 3
pistonDirichletSetPiston dirichlet boundary sets
Unit: -
pistonDirichletTempPiston dirichlet boundary temperatures
Unit: degC
pistonElementSetPiston volume sets and associated material properties
Unit: -
pistonFactorPiston factor
Unit: -
pistonFilmFrictionCoefficientPiston film asperity friction coefficient
Unit: -
pistonIMDirPiston influence Matrix directory
pistonIxxPiston Ixx at socket
Unit: kg*m 2
pistonIyyPiston Iyy at socket
Unit: kg*m 2
pistonIzzPiston Izz at socket
Unit: kg*m 2
pistonMassPiston mass
Unit: kg
pistonMeshPiston thermal mesh file
pistonMixedCoeffPiston mixed boundary fluxes
Unit: W/m 2 /K
pistonMixedSetPiston mixed boundary sets
Unit: -
pistonMixedTempPiston mixed boundary temperature
Unit: degC
pistonNeumannFluxPiston neumann boundary fluxes
Unit: W/m 2
pistonNeumannSetPiston neumann boundary sets
Unit: -
pistonSetConductivityCorresponding thermal conductivities
Unit: W/m/K
pistonSetDensityCorresponding densities
Unit: kg/m 3
pistonSetElasticModCorresponding young’s moduli
Unit: GPa_a
pistonSetExpansionCoeffCorresponding thermal expansion coefficients
Unit: -
pistonSetPoissonCorresponding poisson’s ratios
Unit: -
pistonSTLPiston STL for printing bodies
pocketOrifDiaPocket orifice diameter
Unit: mm
polyCoeffsBlockFilmContact polynomial coefficients block film
Unit: -
polyCoeffsPistonFilmContact polynomial coefficients piston film
Unit: -
polyCoeffsSlipperFilmContact polynomial coefficients slipper film
Unit: -
pScaleIMScaling factor for IM values
Unit: m/bar_a
refDensityReference density
Unit: kg/m 3
relStartRelaxBodyStarting relaxation coefficient
Unit: -
relStopRelaxBodyEnding relaxation coefficient
Unit: -
resultsFileLocation to print the output results to
rOrigBlockIMBlock IM scaling
Unit: m
rOrigBlockSTLBlock STL scaling
Unit: m
rOrigBlockThermalBlock thermal mesh scaling
Unit: m
rOrigPistonIMPiston IM scaling
Unit: m
rOrigPistonSTLPiston STL scaling
Unit: m
rOrigPistonThermalPiston thermal mesh scaling
Unit: m
rOrigSlipperIMSlipper IM scaling
Unit: m
rOrigSlipperSTLSlipper STL scaling
Unit: m
rOrigSlipperThermalSlipper thermal mesh scaling
Unit: m
rOrigSwashplateIMSwashplate IM scaling
Unit: m
rOrigSwashplateSTLSwashplate STL scaling
Unit: m
rOrigSwashplateThermalSwashplate thermal mesh scaling
Unit: m
rOrigVpEndCaseIMValveplate/encase IM scaling
Unit: m
rOrigVpEndCaseSTLValveplate/endcase STL scaling
Unit: m
rOrigVpEndCaseThermalValveplate/endcase thermal mesh scaling
Unit: m
Rq_BlockBlock running surface roughness (Rq)
Unit: micron
Rq_BushingBushing running surface roughness (Rq)
Unit: micron
Rq_PistonPiston running surface roughness (Rq)
Unit: micron
Rq_SlipperSlipper running surface roughness (Rq)
Unit: micron
Rq_SwashplateSwashplate running surface roughness (Rq)
Unit: micron
Rq_VPVP running surface roughness (Rq)
Unit: micron
rSocketSocket radius
Unit: mm
slipperDensitySlipper density
Unit: kg/m 3
slipperDirichletSetSlipper dirichlet boundary sets
Unit: -
slipperDirichletTempSlipper dirichlet boundary temperatures
Unit: degC
slipperElementSetSlipper volume sets and associated material properties
Unit: -
slipperFactorSlipper factor
Unit: -
slipperFilmFrictionCoefficientSlipper film asperity friction coefficient
Unit: -
slipperIMDirSlipper influence Matrix directory
slipperIxxSlipper Ixx at socket
Unit: kg*m 2
slipperIyySlipper Iyy at socket
Unit: kg*m 2
slipperIzzSlipper Izz at socket
Unit: kg*m 2
slipperMassSlipper mass
Unit: kg
slipperMeshSlipper thermal mesh file
slipperMixedCoeffSlipper mixed boundary fluxes
Unit: W/m 2 /K
slipperMixedSetSlipper mixed boundary sets
Unit: -
slipperMixedTempSlipper mixed boundary temperature
Unit: degC
slipperNeumannFluxSlipper neumann boundary fluxes
Unit: W/m 2
slipperNeumannSetSlipper neumann boundary sets
Unit: -
slipperSetConductivityCorresponding thermal conductivities
Unit: W/m/K
slipperSetDensityCorresponding densities
Unit: kg/m 3
slipperSetElasticModCorresponding young’s moduli
Unit: GPa_a
slipperSetExpansionCoeffCorresponding thermal expansion coefficients
Unit: -
slipperSetPoissonCorresponding poisson’s ratios
Unit: -
slipperSTLSlipper STL for printing bodies
spIMDirSwashplate influence Matrix directory
squeezeLimiterSqueeze limiters - scaled with nominal clearance of the interface
Unit: %
swashplateDirichletSetSwashplate dirichlet boundary sets
Unit: -
swashplateDirichletTempSwashplate dirichlet boundary temperatures
Unit: degC
swashplateElementSetSwashplate volume sets and associated material properties
Unit: -
swashplateMeshSwashplate thermal mesh file
swashplateMixedCoeffSwashplate mixed boundary fluxes
Unit: W/m 2 /K
swashplateMixedSetSwashplate mixed boundary sets
Unit: -
swashplateMixedTempSwashplate mixed boundary temperature
Unit: K
swashplateNeumannFluxSwashplate neumann boundary fluxes
Unit: W/m 2
swashplateNeumannSetSwashplate neumann boundary sets
Unit: -
swashplateSetConductivityCorresponding thermal conductivities
Unit: W/m/K
swashplateSetDensityCorresponding densities
Unit: kg/m 3
swashplateSetElasticModCorresponding young’s moduli
Unit: GPa_a
swashplateSetExpansionCoeffCorresponding thermal expansion coefficients
Unit: -
swashplateSetPoissonCorresponding poisson’s ratios
Unit: -
swashplateSTLSwashplate STL for printing bodies
TA+x port side temperature
Unit: degC
TB-x port side temperature
Unit: degC
TCaseCase temperature
Unit: degC
TNomTemperature at which dimensions are specified
Unit: degC
unitConvBlockIMBlock IM transformation
Unit: m
unitConvBlockSTLBlock STL transformation
Unit: m
unitConvBlockThermalBlock thermal mesh transformation
Unit: m
unitConvPistonIMPiston IM transformation
Unit: m
unitConvPistonSTLPiston STL transformation
Unit: m
unitConvPistonThermalPiston thermal mesh transformation
Unit: m
unitConvSlipperIMSlipper IM transformation
Unit: m
unitConvSlipperSTLSlipper STL transformation
Unit: m
unitConvSlipperThermalSlipper thermal mesh transformation
Unit: m
unitConvSwashplateIMSwashplate IM transformation
Unit: m
unitConvSwashplateSTLSwashplate STL transformation
Unit: m
unitConvSwashplateThermalSwashplate thermal mesh transformation
Unit: m
unitConvVpEndCaseIMValveplate/encase IM transformation
Unit: m
unitConvVpEndCaseSTLValveplate/endcase STL transformation
Unit: m
unitConvVpEndCaseThermalValveplate/endcase thermal mesh transformation
Unit: m
vBreakPistonSocketBreakaway velocity for friction calculations in the ball-socket joint
Unit: m/s
vDCBeta0Displacement chamber volume at zero displacement
Unit: mm 3
vpEndCaseDirichletSetValveplate dirichlet boundary sets
Unit: -
vpEndCaseDirichletTempValveplate dirichlet boundary temperatures
Unit: degC
vpEndCaseElementSetValveplate Endcase volume sets and associated material properties
Unit: -
vpEndCaseMeshValveplate/endcase thermal mesh file
vpEndCaseMixedCoeffValveplate mixed boundary fluxes
Unit: W/m 2 /K
vpEndCaseMixedSetValveplate mixed boundary sets
Unit: -
vpEndCaseMixedTempValveplate mixed boundary temperature
Unit: K
vpEndCaseNeumannFluxValveplate neumann boundary fluxes
Unit: W/m 2
vpEndCaseNeumannSetValveplate neumann boundary sets
Unit: -
vpEndCaseSetConductivityCorresponding thermal conductivities
Unit: W/m/K
vpEndCaseSetDensityCorresponding densities
Unit: kg/m 3
vpEndCaseSetElasticModCorresponding young’s moduli
Unit: GPa_a
vpEndCaseSetExpansionCoeffCorresponding thermal expansion coefficients
Unit: -
vpEndCaseSetPoissonCorresponding poisson’s ratios
Unit: -
vpEndCaseSTLValveplate/endcase STL for printing bodies
vpIMDirValveplate influence Matrix directory
vPocketFluid volume enclosed in the slipper pocket
Unit: mm 3
vtkPathLocation to store vtk files
wearTableDirWear table path
yieldBlockYield stress of block
Unit: MPa_a
yieldBushingYield stress of Bushing
Unit: MPa_a
yieldPistonYield stress of Piston
Unit: MPa_a
yieldSlipperYield stress of Slipper
Unit: MPa_a
yieldSwashplateYield stress of Swashplate
Unit: MPa_a
yieldVPYield stress of VP
Unit: MPa_a