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

Table defining inlet/outlet flow areas.

Unit: -

beta

Swashplate inclination angle.

Unit: deg

betaMax

Maximum swashplate inclination angle for the given operating condition.

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

Asperity friction coefficient for the block film.

Unit: -

blockIMDir

Influence matrix file for the cylinder block.

Unit: -

blockIxx

Moment of inertia of the cylinder block about the X-axis.

Unit: kg*m^2

blockIyy

Moment of inertia of the cylinder block about the Y-axis.

Unit: kg*m^2

blockIzz

Moment of inertia of the cylinder block about the Z-axis.

Unit: kg*m^2

blockMass

Mass of the cylinder block.

Unit: kg

blockMesh

Block thermal mesh file

Unit: -

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

Cylinder block STL file.

Unit: -

chmbrAPoly

Polygon definition of Port +x geometry.

Unit: -

chmbrBPoly

Polygon definition of Port -x geometry.

Unit: -

dBore

Diameter of the cylinder bore. For APMs with a separate bushing insert, this value must include the inner diameter of the insert.

Unit: mm

dcPoly

Polygon definition of the displacement chamber geometry.

Unit: -

degPrint

Interval (in degrees) at which to output results. Recommended less than 1 degree.

Unit: deg

degStartRelaxBody

Shaft angle at which to start applying body motion relaxation.

Unit: deg

degStopRelaxBody

Shaft angle at which to stop applying body motion relaxation.

Unit: deg

dInBlock

Inner radius of the block running surface forming the valve plate/block interface.

Unit: mm

dInSlipper

Inner diameter of the slipper running surface forming the slipper/swashplate interface.

Unit: mm

dOutBlock

Outer radius of the block running surface forming the valve plate/block interface.

Unit: mm

dOutSlipper

Outer diameter of the slipper running surface forming the slipper/swashplate interface.

Unit: mm

dPiston

Outer diameter of the piston surface forming the piston/cylinder interface.

Unit: mm

dPitch

Diameter of the circle passing through the centers of the cylinder bores in the cylinder block.

Unit: mm

dySpRot

Y offset of the swashplate rotation center at zero displacement

Unit: mm

dzBlockCG

Distance from the shaft reaction point or the cylinder body origin to the block center of gravity (positive from valve plate to swashplate).

Unit: mm

dzBlockRun

Distance of the cylinder block running surface of the cylinder block-valve plate lubricating film from the block body origin along the z-axis (positive from valve plate to swashplate).

Unit: mm

dzBoreRunSurf

Distance of the bushing running surface center on the block from the cylinder block shaft reaction (crowning) point along the z-axis.

Unit: mm

dzCrown

Distance of the shaft reaction point/block body origin from the global origin along the z-axis (positive dzCrown means the crowning point is shifted towards the swashplate from the ideal position).

Unit: mm

dzPistonCG

Distance from the piston ball head center (or piston body origin) to the piston center of gravity (positive from valve plate to swashplate).

Unit: mm

dzPistonFlatBall

Distance from the piston ball head center to the piston flat end (positive from valve plate to swashplate).

Unit: mm

dzPistonRunSurf

Distance of the piston running surface center from the piston ball head center/piston body origin (positive from valve plate to swashplate).

Unit: mm

dzSlipCG

Distance from the slipper socket center (or slipper body origin) to the slipper center of gravity (positive from valve plate to swashplate).

Unit: mm

dzSlipRun

Distance of the slipper running surface from the slipper socket center/slipper body origin (positive from valve plate to swashplate).

Unit: mm

dzSpRot

Z offset of the swashplate rotation center at zero displacement

Unit: mm

EBlock

Young’s modulus of the cylinder block material (required for mixed lubrication and deformation modeling).

Unit: Gpa

EBushing

Young’s modulus of the bushing material (required for mixed lubrication and deformation modeling).

Unit: Gpa

EPiston

Young’s modulus of the piston material (required for mixed lubrication and deformation modeling).

Unit: Gpa

ESlipper

Young’s modulus of the slipper material (required for mixed lubrication and deformation modeling).

Unit: Gpa

Eswashplate

Young’s modulus of the swashplate material (required for mixed lubrication and deformation modeling).

Unit: Gpa

EVP

Young’s modulus of the valve plate material (required for mixed lubrication and deformation modeling).

Unit: Gpa

FilmMaxTimeStep

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

Unit: %

filmStepMaxGrowth

Maximum growth factor for film time steps.

Unit: %

fluid

Fluid Selection

Unit: -

fluidPropSub

Fluid property file to use for pressures below atmospheric.

Unit: -

fluidPropSuper

Fluid property file to use for pressures above atmospheric.

Unit: -

fluidType

Type of the fluid properties to use.

Unit: -

FSlipperHoldDown

Hold-down force applied on a single slipper.

Unit: N

FSpringBlock

Preload force of the cylinder block spring.

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 at the block interface.

Unit: micron

hInitSlipperFilm

Initial film thickness at the slipper interface.

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 Limit

Unit: %

impShrinkRate

Impedance Matrix Shrinkage Rate

Unit: %

IntegratorAbsTol

Absolute tolerance for solver convergence (recommended 1e-8).

Unit: -

IntegratorMaxSteps

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

Unit: -

IntegratorMaxTimeStep

Maximum number of integration steps allowed.

Unit: s

IntegratorMinTimeStep

Minimum number of integration steps allowed.

Unit: s

IntegratorRelTol

Relative tolerance for solver convergence (recommended 1e-8).

Unit: -

isBlockFilm

Enables the film solver for the block (valve plate interface).

Unit: -

isBoreProfile

Whether to consider surface profile on bore

Unit: -

isDefBlockFilm

Selects how solid deformation is calculated at the block/valve plate interface.

Unit: -

isDefPistonFilm

Selects how solid deformation is calculated at the piston/cylinder interface.

Unit: -

isDefSlipperFilm

Selects how solid deformation is calculated at the slipper/swashplate interface.

Unit: -

isEnergyEqFilms

Whether to solve energy equation in lubricating interfaces

Unit: -

isMixedLubBlockFilm

Enables asperity (mixed lubrication) model for the block/valve plate interface.

Unit: -

isMixedLubPistonFilm

Enables asperity (mixed lubrication) model for the piston/cylinder interface.

Unit: -

isMixedLubSlipperFilm

Enables asperity (mixed lubrication) model for the slipper/swashplate interface.

Unit: -

isPistonFilm

Enables the film solver for the piston (cylinder interface).

Unit: -

isPistonProfile

Whether to consider surface profile on piston

Unit: -

isPrintBody

Exports machine STL geometry for visualization.

Unit: -

isSlipperFilm

Enables the film solver for the slipper (swashplate interface).

Unit: -

isSlipperProfile

Whether to consider surface profile on slipper

Unit: -

isSolidHeatTransfer

Solid body heat transfer

Unit: -

isThermalDeformation

Solid body thermal deformation

Unit: -

lBoreRunSurf

Length of the bushing running surface forming the piston/cylinder interface.

Unit: mm

lPistonRunSurf

Length of the piston running surface forming the piston/cylinder interface.

Unit: mm

maxCFL

Maximum allowable CFL number for film calculations.

Unit: -

muPistonSocketDyn

Dynamic friction coefficient between the ball and socket.

Unit: -

muPistonSocketStat

Static friction coefficient between the ball and socket.

Unit: -

natFreqBlock

Surface roughness of the cylinder block running surface (required for mixed lubrication and deformation modeling).

Unit: micron

natFreqPiston

Natural frequency of the piston.

Unit: Hz

natFreqSlipper

Natural frequency of the slipper.

Unit: Hz

natFreqSwashplate

Natural frequency of the swashplate.

Unit: Hz

natFreqVP

Surface roughness of the valve plate running surface (required for mixed lubrication and deformation modeling).

Unit: micron

nDegDefInit

Shaft angle at which to start applying influence matrices.

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 or displacement chambers in the APM.

Unit: -

nPtsBlockFilm

Number of grid points used to discretize the block film.

Unit: -

nPtsPistonFilm

Number of grid points used to discretize the piston film.

Unit: -

nPtsSlipperFilm

Number of grid points used to discretize the slipper film.

Unit: -

nRev

Number of shaft revolutions to run the simulation.

Unit: -

nRevFluxRelax

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

Unit: -

nuBlock

Poisson’s ratio of the cylinder block material (required for mixed lubrication and deformation modeling).

Unit: -

nuBushing

Poisson’s ratio of the bushing material (required for mixed lubrication and deformation modeling).

Unit: -

nuPiston

Poisson’s ratio of the piston material (required for mixed lubrication and deformation modeling).

Unit: -

nuSlipper

Poisson’s ratio of the slipper material (required for mixed lubrication and deformation modeling).

Unit: -

nuSwashplate

Poisson’s ratio of the swashplate material (required for mixed lubrication and deformation modeling).

Unit: -

nuVP

Poisson’s ratio of the valve plate material (required for mixed lubrication and deformation modeling).

Unit: -

omega

Rotational speed of the shaft (positive = counter-clockwise, negative = clockwise).

Unit: rpm

ompNthreads

Number of threads for parallel implementation

Unit: -

outputListFile

Location to write output availability table (if this entry doesn’t exist, no file written)

Unit: -

pA

Pressure in the port on the +X axis.

Unit: bar

pB

Pressure in the port on the -X axis.

Unit: bar

pCase

Pressure present in the internal housing or casing.

Unit: bar

percDampDefBlock

Percentage damping applied to block deformation.

Unit: %

percDampDefPiston

Percentage damping applied to piston deformation.

Unit: -

percDampDefSlipper

Percentage damping applied to slipper deformation.

Unit: -

percDampDefSwashplate

Percentage damping applied to swashplate deformation.

Unit: %

percDampDefVP

Percentage damping applied to valve plate 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

Asperity friction coefficient for the piston film.

Unit: -

pistonIMDir

Influence matrix file for the piston.

Unit: -

pistonIxx

Moment of inertia of the piston about the X-axis.

Unit: kg*m^2

pistonIyy

Moment of inertia of the piston about the Y-axis.

Unit: kg*m^2

pistonIzz

Moment of inertia of the piston about the Z-axis.

Unit: kg*m^2

pistonMass

Mass of the piston.

Unit: kg

pistonMesh

Piston thermal mesh file

Unit: -

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 file.

Unit: -

pocketOrifDia

Minimum diameter connecting the displacement chamber to the pocket.

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

Relaxation coefficient applied at the start of the relaxation interval.

Unit: -

relStopRelaxBody

Relaxation coefficient applied at the end of the relaxation interval.

Unit: -

resultsFile

Location to print the output results to

Unit: -

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

Natural frequency of the cylinder block.

Unit: Hz

Rq_Bushing

Surface roughness of the bushing running surface (required for mixed lubrication and deformation modeling).

Unit: micron

Rq_Piston

Surface roughness of the piston running surface (required for mixed lubrication and deformation modeling).

Unit: micron

Rq_Slipper

Surface roughness of the slipper running surface (required for mixed lubrication and deformation modeling).

Unit: micron

Rq_Swashplate

Surface roughness of the swashplate running surface (required for mixed lubrication and deformation modeling).

Unit: micron

Rq_VP

Natural Frequency of the valve plate.

Unit: Hz

rSocket

Radius of the slipper socket.

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

Asperity friction coefficient for the slipper film.

Unit: -

slipperIMDir

Influence matrix file for the slipper.

Unit: -

slipperIxx

Moment of inertia of the slipper about the X-axis.

Unit: kg*m^2

slipperIyy

Moment of inertia of the slipper about the Y-axis.

Unit: kg*m^2

slipperIzz

Moment of inertia of the slipper about the Z-axis.

Unit: kg*m^2

slipperMass

Mass of the slipper.

Unit: kg

slipperMesh

Slipper thermal mesh file

Unit: -

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 file.

Unit: -

spIMDir

Influence matrix file for the swashplate.

Unit: -

squeezeLimiter

Scale factor for squeeze limiters relative to previous time step interface gap height.

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

Unit: -

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 file.

Unit: -

TA

Temperature in the port on the +X axis.

Unit: degC

TB

Temperature in the port on the -X axis.

Unit: degC

TCase

Temperature inside the internal housing or casing.

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

Relative velocity at which the ball/socket contact transitions from static to dynamic friction.

Unit: m/s

vDCBeta0

Displacement chamber volume at zero displacement. The included volume depends on piston body geometry.

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

Unit: -

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

Valve plate end case STL file.

Unit: -

vpIMDir

Influence matrix file for the valve plate.

Unit: -

vPocket

Fluid volume enclosed in the slipper pocket.

Unit: mm^3

vtkPath

Path to save VTK output files.

Unit: -

wearTableDir

Wear table path

Unit: -

yieldBlock

Yield stress of the cylinder block material (required for mixed lubrication and deformation modeling).

Unit: Mpa

yieldBushing

Yield stress of the bushing material (required for mixed lubrication and deformation modeling).

Unit: Mpa

yieldPiston

Yield stress of the piston material (required for mixed lubrication and deformation modeling).

Unit: Mpa

yieldSlipper

Yield stress of the slipper material (required for mixed lubrication and deformation modeling).

Unit: Mpa

yieldSwashplate

Yield stress of the swashplate material (required for mixed lubrication and deformation modeling).

Unit: Mpa

yieldVP

Yield stress of the valve plate material (required for mixed lubrication and deformation modeling).

Unit: Mpa