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.

areaTable

In case pressure build up is solved for, the area table is to be given as an input

beta

Swashplate Angle

Unit: deg

betaMax

Maximum swashplate angle

Unit: deg

blockDensity

Block density

Unit: kg/m 3

blockDirichletSet

Block dirichlet boundary sets

Unit: -

blockDirichletTemp

Block dirichlet boundary temperatures

Unit: degC

blockElementSet

Block volume sets and associated material properties

Unit: -

blockFactor

Block factor

Unit: -

blockFilmFrictionCoefficient

Block film asperity friction coefficient

Unit: -

blockIMDir

Block influence Matrix directory

blockIxx

Block Ixx at crowning point

Unit: kg*m 2

blockIyy

Block Iyy at crowning point

Unit: kg*m 2

blockIzz

Block Izz at crowning point

Unit: kg*m 2

blockMass

Block mass

Unit: kg

blockMesh

Block thermal mesh file

blockMixedCoeff

Block mixed boundary fluxes

Unit: W/m 2 /K

blockMixedSet

Block mixed boundary sets

Unit: -

blockMixedTemp

Block mixed boundary temperature

Unit: degC

blockNeumannFlux

Block neumann boundary fluxes

Unit: W/m 2

blockNeumannSet

Block neumann boundary sets

Unit: -

blockSetConductivity

Corresponding thermal conductivities

Unit: W/m/K

blockSetDensity

Corresponding densities

Unit: kg/m 3

blockSetElasticMod

Corresponding young’s moduli

Unit: GPa_a

blockSetExpansionCoeff

Corresponding thermal expansion coefficients

Unit: -

blockSetPoisson

Corresponding poisson’s ratios

Unit: -

blockSTL

Block STL for printing bodies

chmbrAPoly

Polygon file for outlet chamber

chmbrBPoly

Polygon file for inlet chamber

dBore

Diameter of bushing

Unit: mm

dcPoly

Polygon file for displacement chamber

degPrint

Print interval in degrees

Unit: deg

degStartRelaxBody

What shaft angle to start applying relaxation on body motion

Unit: deg

degStopRelaxBody

What shaft angle to start applying relaxation on body motion

Unit: deg

dInBlock

Inner radius of block running surface (vp film)

Unit: mm

dInSlipper

Slipper inner radius

Unit: mm

dOutBlock

Inner radius of block running surface (vp film)

Unit: mm

dOutSlipper

Slipper outer radius

Unit: mm

dPiston

Diameter of piston

Unit: mm

dPitch

Pitch radius

Unit: mm

dySpRot

Y offset of the swashplate rotation center at zero displacement

Unit: mm

dzBlockCG

Z offset from ideal crowning point point to block CG

Unit: mm

dzBlockRun

Z distance between origin and block/valveplate running surface at zero displacement

Unit: mm

dzBoreRunSurf

Bushing running surface center on block from ref(positive sense from vp to sp) ref - Origin

Unit: mm

dzCrown

Z distance between origin and shaft reaction point on block at zero displacement

Unit: mm

dzPistonCG

Z offset from ball center to piston CG

Unit: mm

dzPistonFlatBall

Piston flat end from ball head

Unit: mm

dzPistonRunSurf

Piston running surface center from ball head(positive sense from vp to sp)

Unit: mm

dzSlipCG

Z offset from socket center to slipper CG

Unit: mm

dzSlipRun

Slipper running surface from socket center

Unit: mm

dzSpRot

Z offset of the swashplate rotation center at zero displacement

Unit: mm

EBlock

Block Young’s modulus

Unit: GPa_a

EBushing

Bushing Young’s modulus

Unit: GPa_a

EPiston

Piston Young’s modulus

Unit: GPa_a

ESlipper

Slipper Young’s modulus

Unit: GPa_a

ESwashplate

Swashplate Young’s modulus

Unit: GPa_a

EVP

VP Young’s modulus

Unit: GPa_a

FilmMaxTimeStep

Maximum time step for a lubricating film (optional, user can keep blank and it will stick to default)

Unit: s

filmStepMaxGrowth

Maximum growth of film time steps

Unit: %

fluidPropSub

Location of sub atmospheric fluid property file

fluidPropSuper

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

FSlipperHoldDown

Slipper Hold down force

Unit: N

FSpringBlock

Block Spring force

Unit: N

hBlock_casinginner

Block heat transfer coefficient to inner casing fluid

Unit: W/m 2 /K

hBlock_casingouter

Block heat transfer coefficient to inner casing fluid

Unit: W/m 2 /K

hBlock_dc

Block heat transfer coefficient to displacement chamber fluid

Unit: W/m 2 /K

hBlock_groovebearing

Block heat transfer coefficient to inner casing fluid

Unit: W/m 2 /K

hBlock_outerbearing

Block heat transfer coefficient to inner casing fluid

Unit: W/m 2 /K

hInitBlockFilm

Initial film thickness on block Film

Unit: micron

hInitSlipperFilm

Initial film thickness on slipper Film

Unit: micron

hPiston_ball

Piston heat transfer coefficient to casing fluid through ball joint

Unit: W/m 2 /K

hPiston_case

Piston heat transfer coefficient to casing fluid through casing surface

Unit: W/m 2 /K

hPiston_dc

Piston heat transfer coefficient to displacement chamber fluid

Unit: W/m 2 /K

hSlipper_case

Slipper heat transfer coefficient to casing fluid through casing surface

Unit: W/m 2 /K

hSlipper_pocket

Slipper heat transfer coefficient to pocket fluid

Unit: W/m 2 /K

hSlipper_socket

Slipper heat transfer coefficient to casing fluid through ball joint

Unit: W/m 2 /K

hSP_casing

Swashplate heat transfer coefficient to casing

Unit: W/m 2 /K

hVP_casing

Valveplate heat transfer coefficient to casing

Unit: W/m 2 /K

hVP_hp

Valveplate heat transfer coefficient to outlet chamber in casing

Unit: W/m 2 /K

hVP_lp

Valveplate heat transfer coefficient to inlet chamber in casing

Unit: W/m 2 /K

hVP_outerbearing

Valveplate heat transfer coefficient to casing

Unit: W/m 2 /K

impContr

Impedance contribution threshold

Unit: %

impContrHard

Impedance contribution hard threshold

Unit: %

impShrinkRate

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

IntegratorMaxSteps

Maximum steps for the integrator (optional, user can keep blank and it will stick to default)

Unit: -

IntegratorMaxTimeStep

Maximum time step for the integrator (optional, user can keep blank and it will stick to default)

Unit: s

IntegratorRelTol

Relative tolerance for the integrator

Unit: -

isBlockFilm

Whether to solve for the cylinder block film

Unit: -

isBoreProfile

Whether to consider surface profile on bore

Unit: -

isDefBlockFilm

Whether to consider deformation in the block film 0 - no deformation, 1 - analytical micro deformation, 2 - influence matrix

Unit: -

isDefPistonFilm

Whether to consider deformation in the piston film 0 - no deformation, 1 - analytical micro deformation, 2 - influence matrix

Unit: -

isDefSlipperFilm

Whether to consider deformation in the slipper film

Unit: -

isEnergyEqFilms

Whether to solve energy equation in lubricating interfaces

Unit: -

isMixedLubBlockFilm

Whether to consider mixed lubrication in the block film

Unit: -

isMixedLubPistonFilm

Whether to consider mixed lubrication in the piston film

Unit: -

isMixedLubSlipperFilm

Whether to consider mixed lubrication in the slipper film

Unit: -

isPistonFilm

Whether to solve for piston film

Unit: -

isPistonProfile

Whether to consider surface profile on piston

Unit: -

isPrintBody

Flag notifying if bodies are to be printed

Unit: -

isSlipperFilm

Whether to solve for slipper film

Unit: -

isSlipperProfile

Whether to consider surface profile on slipper

Unit: -

isSolidHeatTransfer

Solid body heat transfer

Unit: -

isThermalDeformation

Solid body thermal deformation

Unit: -

lBoreRunSurf

Bushing running surface length

Unit: mm

lPistonRunSurf

Piston running surface length

Unit: mm

maxCFL

Maximum CFL for films

Unit: -

muPistonSocketDyn

Dynamic friction coefficient of the ball-socket joint

Unit: -

muPistonSocketStat

Static friction coefficient of the ball-socket joint

Unit: -

natFreqBlock

Natural frequency of block

Unit: Hz

natFreqPiston

Natural frequency of Piston

Unit: Hz

natFreqSlipper

Natural frequency of Slipper

Unit: Hz

natFreqSwashplate

Natural frequency of Swashplate

Unit: Hz

natFreqVP

Natural frequency of VP

Unit: Hz

nDegDefInit

Degree till which influence matrices are not applied

Unit: deg

nDegThermalCalc

Degrees at which solid temperature to be updated

Unit: deg

nDegThermalSample

Degree interval at which heat flux is to be sampled

Unit: deg

nPiston

Number of pistons

Unit: -

nPtsBlockFilm

Number of points on block film

Unit: -

nPtsPistonFilm

Number of points on piston film

Unit: -

nPtsSlipperFilm

Number of points on slipper film

Unit: -

nRev

Number of revolutions to run

Unit: -

nRevFluxRelax

Number of revolutions till which the heat flux from the interfaces are to be relaxed

Unit: -

nuBlock

Block Poisson’s ratio

Unit: -

nuBushing

Bushing Poisson’s ratio

Unit: -

nuPiston

Piston Poisson’s ratio

Unit: -

nuSlipper

Slipper Poisson’s ratio

Unit: -

nuSwashplate

Swashplate Poisson’s ratio

Unit: -

nuVP

VP Poisson’s ratio

Unit: -

omega

Shaft speed

Unit: rev/min

ompNthreads

Number of threads for parallel implementation

Unit: -

outputListFile

Location 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

pCase

Case pressure

Unit: bar

percDampDefBlock

Percentage damping on block deformation

Unit: %

percDampDefPiston

Percentage damping on block deformation

Unit: %

percDampDefSlipper

Percentage damping on block deformation

Unit: %

percDampDefSwashplate

Percentage damping on block deformation

Unit: %

percDampDefVP

Percentage damping on block deformation

Unit: %

pistonDensity

Piston density

Unit: kg/m 3

pistonDirichletSet

Piston dirichlet boundary sets

Unit: -

pistonDirichletTemp

Piston dirichlet boundary temperatures

Unit: degC

pistonElementSet

Piston volume sets and associated material properties

Unit: -

pistonFactor

Piston factor

Unit: -

pistonFilmFrictionCoefficient

Piston film asperity friction coefficient

Unit: -

pistonIMDir

Piston influence Matrix directory

pistonIxx

Piston Ixx at socket

Unit: kg*m 2

pistonIyy

Piston Iyy at socket

Unit: kg*m 2

pistonIzz

Piston Izz at socket

Unit: kg*m 2

pistonMass

Piston mass

Unit: kg

pistonMesh

Piston thermal mesh file

pistonMixedCoeff

Piston mixed boundary fluxes

Unit: W/m 2 /K

pistonMixedSet

Piston mixed boundary sets

Unit: -

pistonMixedTemp

Piston mixed boundary temperature

Unit: degC

pistonNeumannFlux

Piston neumann boundary fluxes

Unit: W/m 2

pistonNeumannSet

Piston neumann boundary sets

Unit: -

pistonSetConductivity

Corresponding thermal conductivities

Unit: W/m/K

pistonSetDensity

Corresponding densities

Unit: kg/m 3

pistonSetElasticMod

Corresponding young’s moduli

Unit: GPa_a

pistonSetExpansionCoeff

Corresponding thermal expansion coefficients

Unit: -

pistonSetPoisson

Corresponding poisson’s ratios

Unit: -

pistonSTL

Piston STL for printing bodies

pocketOrifDia

Pocket orifice diameter

Unit: mm

polyCoeffsBlockFilm

Contact polynomial coefficients block film

Unit: -

polyCoeffsPistonFilm

Contact polynomial coefficients piston film

Unit: -

polyCoeffsSlipperFilm

Contact polynomial coefficients slipper film

Unit: -

pScaleIM

Scaling factor for IM values

Unit: m/bar_a

refDensity

Reference density

Unit: kg/m 3

relStartRelaxBody

Starting relaxation coefficient

Unit: -

relStopRelaxBody

Ending relaxation coefficient

Unit: -

resultsFile

Location to print the output results to

rOrigBlockIM

Block IM scaling

Unit: m

rOrigBlockSTL

Block STL scaling

Unit: m

rOrigBlockThermal

Block thermal mesh scaling

Unit: m

rOrigPistonIM

Piston IM scaling

Unit: m

rOrigPistonSTL

Piston STL scaling

Unit: m

rOrigPistonThermal

Piston thermal mesh scaling

Unit: m

rOrigSlipperIM

Slipper IM scaling

Unit: m

rOrigSlipperSTL

Slipper STL scaling

Unit: m

rOrigSlipperThermal

Slipper thermal mesh scaling

Unit: m

rOrigSwashplateIM

Swashplate IM scaling

Unit: m

rOrigSwashplateSTL

Swashplate STL scaling

Unit: m

rOrigSwashplateThermal

Swashplate thermal mesh scaling

Unit: m

rOrigVpEndCaseIM

Valveplate/encase IM scaling

Unit: m

rOrigVpEndCaseSTL

Valveplate/endcase STL scaling

Unit: m

rOrigVpEndCaseThermal

Valveplate/endcase thermal mesh scaling

Unit: m

Rq_Block

Block running surface roughness (Rq)

Unit: micron

Rq_Bushing

Bushing running surface roughness (Rq)

Unit: micron

Rq_Piston

Piston running surface roughness (Rq)

Unit: micron

Rq_Slipper

Slipper running surface roughness (Rq)

Unit: micron

Rq_Swashplate

Swashplate running surface roughness (Rq)

Unit: micron

Rq_VP

VP running surface roughness (Rq)

Unit: micron

rSocket

Socket radius

Unit: mm

slipperDensity

Slipper density

Unit: kg/m 3

slipperDirichletSet

Slipper dirichlet boundary sets

Unit: -

slipperDirichletTemp

Slipper dirichlet boundary temperatures

Unit: degC

slipperElementSet

Slipper volume sets and associated material properties

Unit: -

slipperFactor

Slipper factor

Unit: -

slipperFilmFrictionCoefficient

Slipper film asperity friction coefficient

Unit: -

slipperIMDir

Slipper influence Matrix directory

slipperIxx

Slipper Ixx at socket

Unit: kg*m 2

slipperIyy

Slipper Iyy at socket

Unit: kg*m 2

slipperIzz

Slipper Izz at socket

Unit: kg*m 2

slipperMass

Slipper mass

Unit: kg

slipperMesh

Slipper thermal mesh file

slipperMixedCoeff

Slipper mixed boundary fluxes

Unit: W/m 2 /K

slipperMixedSet

Slipper mixed boundary sets

Unit: -

slipperMixedTemp

Slipper mixed boundary temperature

Unit: degC

slipperNeumannFlux

Slipper neumann boundary fluxes

Unit: W/m 2

slipperNeumannSet

Slipper neumann boundary sets

Unit: -

slipperSetConductivity

Corresponding thermal conductivities

Unit: W/m/K

slipperSetDensity

Corresponding densities

Unit: kg/m 3

slipperSetElasticMod

Corresponding young’s moduli

Unit: GPa_a

slipperSetExpansionCoeff

Corresponding thermal expansion coefficients

Unit: -

slipperSetPoisson

Corresponding poisson’s ratios

Unit: -

slipperSTL

Slipper STL for printing bodies

spIMDir

Swashplate influence Matrix directory

squeezeLimiter

Squeeze limiters - scaled with nominal clearance of the interface

Unit: %

swashplateDirichletSet

Swashplate dirichlet boundary sets

Unit: -

swashplateDirichletTemp

Swashplate dirichlet boundary temperatures

Unit: degC

swashplateElementSet

Swashplate volume sets and associated material properties

Unit: -

swashplateMesh

Swashplate thermal mesh file

swashplateMixedCoeff

Swashplate mixed boundary fluxes

Unit: W/m 2 /K

swashplateMixedSet

Swashplate mixed boundary sets

Unit: -

swashplateMixedTemp

Swashplate mixed boundary temperature

Unit: K

swashplateNeumannFlux

Swashplate neumann boundary fluxes

Unit: W/m 2

swashplateNeumannSet

Swashplate neumann boundary sets

Unit: -

swashplateSetConductivity

Corresponding thermal conductivities

Unit: W/m/K

swashplateSetDensity

Corresponding densities

Unit: kg/m 3

swashplateSetElasticMod

Corresponding young’s moduli

Unit: GPa_a

swashplateSetExpansionCoeff

Corresponding thermal expansion coefficients

Unit: -

swashplateSetPoisson

Corresponding poisson’s ratios

Unit: -

swashplateSTL

Swashplate STL for printing bodies

TA

+x port side temperature

Unit: degC

TB

-x port side temperature

Unit: degC

TCase

Case temperature

Unit: degC

TNom

Temperature at which dimensions are specified

Unit: degC

unitConvBlockIM

Block IM transformation

Unit: m

unitConvBlockSTL

Block STL transformation

Unit: m

unitConvBlockThermal

Block thermal mesh transformation

Unit: m

unitConvPistonIM

Piston IM transformation

Unit: m

unitConvPistonSTL

Piston STL transformation

Unit: m

unitConvPistonThermal

Piston thermal mesh transformation

Unit: m

unitConvSlipperIM

Slipper IM transformation

Unit: m

unitConvSlipperSTL

Slipper STL transformation

Unit: m

unitConvSlipperThermal

Slipper thermal mesh transformation

Unit: m

unitConvSwashplateIM

Swashplate IM transformation

Unit: m

unitConvSwashplateSTL

Swashplate STL transformation

Unit: m

unitConvSwashplateThermal

Swashplate thermal mesh transformation

Unit: m

unitConvVpEndCaseIM

Valveplate/encase IM transformation

Unit: m

unitConvVpEndCaseSTL

Valveplate/endcase STL transformation

Unit: m

unitConvVpEndCaseThermal

Valveplate/endcase thermal mesh transformation

Unit: m

vBreakPistonSocket

Breakaway velocity for friction calculations in the ball-socket joint

Unit: m/s

vDCBeta0

Displacement chamber volume at zero displacement

Unit: mm 3

vpEndCaseDirichletSet

Valveplate dirichlet boundary sets

Unit: -

vpEndCaseDirichletTemp

Valveplate dirichlet boundary temperatures

Unit: degC

vpEndCaseElementSet

Valveplate Endcase volume sets and associated material properties

Unit: -

vpEndCaseMesh

Valveplate/endcase thermal mesh file

vpEndCaseMixedCoeff

Valveplate mixed boundary fluxes

Unit: W/m 2 /K

vpEndCaseMixedSet

Valveplate mixed boundary sets

Unit: -

vpEndCaseMixedTemp

Valveplate mixed boundary temperature

Unit: K

vpEndCaseNeumannFlux

Valveplate neumann boundary fluxes

Unit: W/m 2

vpEndCaseNeumannSet

Valveplate neumann boundary sets

Unit: -

vpEndCaseSetConductivity

Corresponding thermal conductivities

Unit: W/m/K

vpEndCaseSetDensity

Corresponding densities

Unit: kg/m 3

vpEndCaseSetElasticMod

Corresponding young’s moduli

Unit: GPa_a

vpEndCaseSetExpansionCoeff

Corresponding thermal expansion coefficients

Unit: -

vpEndCaseSetPoisson

Corresponding poisson’s ratios

Unit: -

vpEndCaseSTL

Valveplate/endcase STL for printing bodies

vpIMDir

Valveplate influence Matrix directory

vPocket

Fluid volume enclosed in the slipper pocket

Unit: mm 3

vtkPath

Location to store vtk files

wearTableDir

Wear table path

yieldBlock

Yield stress of block

Unit: MPa_a

yieldBushing

Yield stress of Bushing

Unit: MPa_a

yieldPiston

Yield stress of Piston

Unit: MPa_a

yieldSlipper

Yield stress of Slipper

Unit: MPa_a

yieldSwashplate

Yield stress of Swashplate

Unit: MPa_a

yieldVP

Yield stress of VP

Unit: MPa_a