National Aeronautics and Space Administration NPSS Reference Sheets Software Release: NPSS_1.6.5 Doc. #: NPSS–Ref Sheets Doc Revision: W Revision Date: March 12, 2008 Numerical Propulsion System Simulation NASA John H. Glenn Research Center at Lewis Field NASA Industry Cooperative Effort 21000 Brookpark Rd. (NPSS/NICE) Cleveland, Ohio 44135-3191 Copyright 1997, 2001, 2002. The United States Government, as Represented by the Administrator of the National Aeronautics and Space Administration (NASA). All rights reserved. Controlled Distribution Further distribution requires written approval of the NASA Glenn Research Center, ECleveland, Ohio
260
Embed
NPSS Reference Sheets - Wolverine Ventureswolverine-ventures.com/userdocs/ReferenceSheets.pdf · 2009-03-31 · Chapter 2: The Element Reference Sheets list the active NPSS Air Breathing
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
National Aeronautics and Space Administration
NPSS Reference Sheets
Software Release: NPSS_1.6.5
Doc. #: NPSS–Ref Sheets Doc Revision: W
Revision Date: March 12, 2008
Numerical Propulsion System Simulation NASA John H. Glenn Research Center at Lewis Field NASA Industry Cooperative Effort 21000 Brookpark Rd. (NPSS/NICE) Cleveland, Ohio 44135-3191
Copyright 1997, 2001, 2002. The United States Government, as Represented by the Administrator of the National Aeronautics and Space Administration (NASA).
All rights reserved.
Controlled Distribution Further distribution requires written approval of the NASA Glenn Research Center,
ECleveland, Ohio
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
ii Revision Page
Note: In the Bleed reference sheets (and those with similar ports) where it used to say “0 to N BleedIn[or Out]Ports” (or “BleedInputPort, ShaftInputPort, etc.) it was changed manually to say: “BleedIn[Out]Port (0 to n).” This was done to avoid confusion as the code gives the singular “BleedIn[Out]Port” without the “s.” When these and similar reference sheets (e.g., BleedOut, BleedInterstage, Compressor, Shaft, Turbine) are updated, the AutoDoc-generated cartoon will show the old way because a CR has not been implemented to change the code.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Contents iii
Table Of Contents
PREFACE ................................................................................ IX
Preface This document was originally part of the User Guide and should be used in conjunction with that document. It contains the following chapters: Chapter 1: The Thermodynamic References Sheets present flowstation and fuel station information on Therm,
Janaf, and GasTbl thermo packages. Chapter 2: The Element Reference Sheets list the active NPSS Air Breathing Elements (alphabetically) followed
by inactive ones, which are documented in case they are needed for older models. Information on the elements gives the NPSS implementation name and may include the following: a diagram, a table of variables, flow stations, option variables, ports (bleed, fluid, mechanical), sockets, tables, thermal masses, dependents/independents associated with the specific element, and usage notes.
Chapter 3: The Subelement Reference Sheets also contain information on variables, flow stations, option variables, ports, sockets, tables, thermal masses, dependents/independents, and usage notes, where appropriate.
Chapter 4: The Port Reference Sheets provide information on variables, functions, and option variables for the various port types.
Chapter 5: The ToolBox Elements Reference Sheets contain the same type of information as the other elements.
However, since they are not considered to be air breathing components they are listed in a separate chapter. Chapter 6: Infrastructure Reference Sheets provides some limited information on the infrastructure objects such
as Socket, MsgHandler, and Tokenizer. Chapter 7: DataViewer Reference Sheets contain data on the various types of data viewers. Chapter 8: Solver Reference Sheets contain information on the Solver including the Linear Model Generator and
Secant Solver. (Note that may variable descriptions are missing as they are not in the code and AutoDoc pulls information directly from the code.)
Chapter 9: External Components Reference Sheets have information on external elements, subelements and containers.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Thermo Reference Sheets 1-1
1 Thermodynamic Reference Sheets Please see the Function Summary Chapter in the User Guide for FlowStation Functions. Software Release: NPSS_1.6.4 - Rev: AI Document Generation Date: 01/08/08
allFuelFuelStation has a baseType of VariableContainer.
[ Back to Index ]
1.4 CEAFlowStation
Variables
Variable Description Default Units IO Status
MNfroz Mach number used to freeze the flow -9999 unset
MW Molecular weight 28.9652 unset
Wreac1 Percentage of the flow that is Wreac1 1 none output
Wreac2 Percentage of the flow that is Wreac2 0 none output
Wreac3 Percentage of the flow that is Wreac3 0 none output
Wreac4 Percentage of the flow that is Wreac4 0 none output
Wreac5 Percentage of the flow that is Wreac5 0 none output
Wreac6 Percentage of the flow that is Wreac6 0 none output
Wreac7 Percentage of the flow that is Wreac7 0 none output
Wreac8 Percentage of the flow that is Wreac8 0 none output
Wreac9 Percentage of the flow that is Wreac9 0 none output
Wreac10 Percentage of the flow that is Wreac10 0 none output
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Thermo Reference Sheets 1-4
comp Composition CEA unset
inertBurnReac1 Percentage of reactant 1 to be moved to reactant 6 (inerted) during a burn 0 none input
inertBurnReac2 Percentage of reactant 2 to be moved to reactant 6 (inerted) during a burn 0 none input
inertBurnReac3 Percentage of reactant 3 to be moved to reactant 6 (inerted) during a burn 0 none input
inertBurnReac4 Percentage of reactant 4 to be moved to reactant 6 (inerted) during a burn 0 none input
inertBurnReac5 Percentage of reactant 5 to be moved to reactant 6 (inerted) during a burn 0 none input
inertBurnReac6 Percentage of reactant 6 to be moved to reactant 6 (inerted) during a burn 0 none input
inertBurnReac7 Percentage of reactant 7 to be moved to reactant 6 (inerted) during a burn 0 none input
inertBurnReac8 Percentage of reactant 8 to be moved to reactant 6 (inerted) during a burn 0 none input
inertBurnReac9 Percentage of reactant 9 to be moved to reactant 6 (inerted) during a burn 0 none input
inertBurnReac10 Percentage of reactant 10 to be moved to reactant 6 (inerted) during a burn 0 none input
reac1 Name of reac1 Air output
reac2 Name of reac2 H2O output
reac3 Name of reac3 empty output
reac4 Name of reac4 empty output
reac5 Name of reac5 empty output
reac6 Name of reac6 empty output
reac7 Name of reac7 empty output
reac8 Name of reac8 empty output
reac9 Name of reac9 empty output
reac10 Name of reac10 empty output
Option Variables
Variable Description Variables IOStatus Affected
Default Allowed Values
switchPrint When set to TRUE, NPSS fill produce standard CEA output files. .ceaout for the total conditions, .ceaoutStatic for the static conditions.
None FALSE FALSE, TRUE
switchTransport Determines if the transports are calculated. NONE indicates they are not calculated. EQUI indicates they are calculated based on equilibirum chemistry. FROZEN indicates they are calculated based on frozen chemistry.
None NONE NONE, EQUIL, FROZEN
CEAFlowStation has a baseType of FlowStation.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Thermo Reference Sheets 1-5
[ Back to Index ]
1.5 CEAFuelStation
Variables
Variable Description Default Units IO Status
CHRatio Carbon to Hydrogen ratio 0 none output
HCRatio Hydrogen to Carbon ratio 0 none output
LHV Lower heating value 0 Btu/lbm output
Pfuel Pressure 0 psia output
Tfuel Temperature 530 R output
TrefFuel Fuel reference temperature 530 R output
Wfuel Weight flow 0 lbm/sec output
hFuel Specific enthalpy 0 Btu/lbm output
hRefFuel Specific enthalpy at reference temperature 0 Btu/lbm output
kFuel INTERNAL USE ONLY 0 none output
CEAFuelStation has a baseType of FuelStation.
[ Back to Index ]
1.6 FlowStation
Variables
Variable Description Default Units IO Status
A Physical cross sectional area 0 in2 output
Aphy Physical cross sectional area 0 in2 output
AphyDes Design physical cross sectional area 0 in2 input by default inactive when switchDes=OFFDESIGN
Cd Discharge coefficient 1 none input
Cps Cp based on static conditions NaN Btu/(lbm*R) output
Cpt Cp based on total conditions NaN Btu/(lbm*R) output
Cvs Cv based on static conditions NaN Btu/(lbm*R) output
Cvt Cv based on total conditions NaN Btu/(lbm*R) output
FAR Fuel-to-air ratio 0 lbm/lbm output
MN Mach number 0 none output
MNdes Design Mach number 0 none input by default inactive when switchDes=OFFDESIGN
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Thermo Reference Sheets 1-6
Prs Prandtl number based on static conditions 0 none output
Prt Prandtl number based on total conditions NaN none output
Ps Static pressure 0 psia output
PsSat Saturation pressure based on static conditions NaN psia output
Pt Total pressure 14.696 psia output
PtSat Saturation pressure based on total conditions NaN psia output
Rs Gas constant based on static conditions 0 Btu/(lbm*R) output
Rt Gas constant based on total conditions NaN Btu/(lbm*R) output
S Entropy NaN Btu/(lbm*R) output
Ts Static temperature 0 R output
TsSat Saturation temperature based on static conditions 0 R output
Tt Total temperature 518.67 R output
TtSat Saturation temperature based on total conditions NaN R output
V Flow velocity 0 ft/sec output
Vflow Flow velocity 0 ft/sec output
W Total Weight flow 0 lbm/sec output
WAR Water-to-air ratio 0 lbm/lbm output
Wa Air flow 0 lbm/sec output
Wc Corrected weight flow 0 lbm/sec output
Wf Fuel flow 0 lbm/sec output
Wflow Weight flow 0 lbm/sec output
Wh Water flow 0 lbm/sec output
Wp Referred weight flow 0 lbm/sec output
Zs Compressibility based on static conditions 0 none output
Zt Compressibility based on total conditions NaN none output
entropy entropy NaN Btu/(lbm*R) output
gams gamma based on static conditions 0 none output
gamt gamma based on total conditions NaN none output
hs enthalpy based on static conditions 0 Btu/lbm output
ht enthalpy based on total conditions 0 Btu/lbm output
imp Impulse function (mass*velocity + pressure * area)
0 lbf output
kc Conductivity based on total conditions. In GasTbl and Janaf, values are based on tables of air as a function of temperature at atmospheric pressure.
NaN Btu/(sec*ft*R) output
ks Conductivity based on static conditions. In GasTbl and Janaf, values are based on tables of air as a function of temperature at atmospheric pressure.
0 Btu/(sec*ft*R) output
kt Conductivity based on total conditions. In GasTbl and Janaf, values are based on tables of air as a function of temperature at atmospheric pressure.
NaN Btu/(sec*ft*R) output
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Thermo Reference Sheets 1-7
mu Viscosity based on total conditions NaN lbm/(ft*sec) output
mus Viscosity based on static conditions NaN lbm/(ft*sec) output
mut Viscosity based on total conditions NaN lbm/(ft*sec) output
rhos Density based on static conditions 0 lbm/ft3 output
rhot Density based on total conditions NaN lbm/ft3 output
swirl Swirl angle 0 rad output
us Internal energy based on static conditions NaN Btu/lbm output
ut Internal energy based on total conditions NaN Btu/lbm output
Option Variables
Variable Description Variables IOStatus Affected
Default Allowed Values
Dissociated Indicates whether the fluid is dissociated or not
None ON ON, OFF
reconstitute Determines if frozen or equilibirum conditions are desired
None EQUIL EQUIL, FROZEN
staticComp None TOTAL TOTAL, STATIC, SEPARATE
superOrSub Deterimines if the subsonic or supersonic static conditions are desired
None SUBSONIC SUBSONIC, SUPERSONIC
switchChokedMethod Determines the method used to determine the statics when the flowstation is choked. INVERt will decrease the area and determine a supersonic solution. HOLD will set the static conditions to the choked value.
None INVERT INVERT, HOLD
switchDes Indicates if the flowstation is in design or off-design mode
AphyDes, MNdes
DESIGN DESIGN, OFFDESIGN
switchGamma Indicates whether the statics will be calculated using a constant or variable gamma
None VARIABLE VARIABLE, CONSTANT
switchOffDesForceStatic Determines if the statics are calculated when the off statiion in put in off-design mode and the statics have not been set yet.
None TRUE TRUE, FALSE
FlowStation has a baseType of VariableContainer.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Thermo Reference Sheets 1-8
[ Back to Index ]
1.7 FPTFlowStation
Variables
Variable Description Default Units IO Status
Cps_eq equilibrium, constant pressure specific heat at static conditions 0 Btu/(lbm*R) output
Cps_fz frozen, constant pressure specific heat at static conditions 0 Btu/(lbm*R) output
Cpt_eq equilibrium, constant pressure specific heat at total conditions 0 Btu/(lbm*R) output
Cpt_fz frozen, constant volume specific heat at total conditions 0 Btu/(lbm*R) output
Cvs_eq equilibrium, constant volume specific heat at static conditions 0 Btu/(lbm*R) output
Cvs_fz frozen, constant volume specific heat at static conditions 0 Btu/(lbm*R) output
Cvt_eq equilibrium, constant volume specific heat at total conditions 0 Btu/(lbm*R) output
Cvt_fz frozen, constant volume specific heat at total conditions 0 Btu/(lbm*R) output
MW Molecular weight of the fluid 0 none output
comp Composition of fluid Default none input
ks_eq equilibrium thermal conductivity at static conditions 0 Btu/(sec*ft*R) output
ks_fz frozen thermal conductivity at static conditions 0 Btu/(sec*ft*R) output
kt_eq equilibrium thermal conductivity at total conditions 0 Btu/(sec*ft*R) output
kt_fz frozen thermal conductivity at total conditions 0 Btu/(sec*ft*R) output
Option Variables
Variable Description Variables IOStatus Affected
Default Allowed Values
switchTransport Indicates whether the frozen or equilibrium properties should be used.
hRefFuel Specific enthalpy at reference conditions 0 Btu/lbm output
kFuel INTERNAL USE ONLY 0 none output
JanafFuelStation has a baseType of FuelStation.
[ Back to Index ]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-1
2 Element Reference Sheets The following reference Sheets list the elements (this section) and subelements (next section) with their NPSS implementation name. The sheets contain a table of variables for each element/subelement; where appropriate, they also include the following: flow stations, option variables, ports (bleed, fluid, mechanical), sockets, tables, thermal masses, and dependents/independents associated with the specific element or subelement. An element’s variables are presented in a table in alphabetical order by coding name. Each table of variables contains five columns. The first column contains the name that is used within the NPSS code. The second column contains the description of the variable. This description does not match exactly with the description in the
header file of the code, but is a general description that can cover all uses of this variable. The third column is the variable’s default value. The fourth column contains the variable’s units, if applicable. If the variable has no units, none will be displayed. The last column shows IOstatus, for example, “input,” “output,” and “unset.” This column may also contain information
specifying when a variable’s IOstatus is “input” and when it is “output.” If a socket is empty, the IOstatus is “input.” (For more information on IOstatus, see the User Guide.)
Variable Naming Conventions Some general rules were followed in determining the NPSS naming conventions for variables. They are: Names start with lower case letters except for common usage names: A, P, T, C, Re Fluid Ports start with Fl_ Sockets start with S_ Tables start with TB_ Shafts start with Sh_ Adders start with a_ Scalars start with s_ Base added to the end of a variable name refers to a variable that is passed from a socket All option switches begin with switch. First and second words in name alternate case of starting letter; remaining words all start with upper case followed by lower
case Subscripts for “total” and “static” are always lower case: t, s
Elements/Subelements with Sockets
The following table lists the Elements/Subelements that have sockets. Please refer to the refererence sheet for a particular element to verify what socket type is required.
Figure 2-1. Elements/Subelements with Sockets
Element Socket Name
SocketType Function
Ambient S_FE S_rec S_TDay
FLIGHT_ENVELOPE RAM_RECOVERY TDAY
Flight Envelope Freestream ram pressure recovery Deviation from ambient Tstd.
Bleed S_Qhx HEATTRANSFER Thermal mass storage BleedOut S_map
S_+portName BLEED_MAP BLEED_FLOW
Properties of interstage bld source Wq map
BleedOutInterstage S_map S_+portName
BLEED_MAP BLEED_FLOW
Properties of interstage bld source Flow fraction
Burner S_dPgrowth S_dPqP
DPGROWTH ADIAB_DPNORM
Dry duct pressure loss Dry duct pressure loss
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-2
S_eff S_Qhx
BURN_EFFICIENCY HEATTRANSFER
Burner adiabatic efficiency Thermal mass storage
Compressor S_map S_Qhx
COMPRESSOR_MAP HEATTRANSFER
Compressor performance map Thermal mass storage
CrossOverValve S_vW VALVE Flow through valve Diffuser S_dP DPDIFFUSER dPqP Duct S_dP ADIAB_DPNORM Pressure loss ExternalDB S_ExtDB EXTERNALDB_SUBELEMENT FuelStart S_hFuel HFUEL Fuel enthalpy from input P & T HeatExchanger S_dPqP1
S_dPqP2 S_Q
ADIAB_DPNORM ADIAB_DPNORM HX_QE
Stream 1 pressure loss calc Stream 2 pressure loss calc Heat flow from stream 1 to 2
Valve Subelement S_dP ADIAB_DPNORM Valve pressure loss The following table lists the sockets types that are available. However, please refer to the refererence sheet for a particular subelement to verify the subelement socket type that is available.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-3
Figure 2-2. Available Sockets
SocketType Socket (Subelement) ADIAB_DPNORM dPqPMach ADIAB_DPNORM dPqP BLEED_MAP No socket available BLEED_FLOW No socket available BURN_EFFICIENCY BurnEfficiency CANGULAR no socket available CDTH no socket available CFGR no socket available CIMP no socket available CMIX no socket available CPMIX no socket available CQUA no socket available COMP_TEMP_MAP CompTempMap COMP_TEMP_MAP_HUM CompTempMapHum COMP_TEMP_MAP_RE CompTempMapRe COMPRESSOR_EFFICIENCY_MAP CompressorEfficiencyMap COMPRESSOR_HUMIDITY_EFFECTS CompressorHumidityEffects COMPRESSOR_MAP CompressorMap COMPRESSOR_MAP CompTempSub COMPRESSOR_REYNOLDS_EFFECTS CompressorReynoldsEffects CVELOCITY no socket available DPDIFFUSER dPdiffuser DPGROWTH no socket available EXTERNALDB_SUBELEMENT wsfr FLIGHT_ENVELOPE FlightEnvelope GENERAL_SUBELEMENT GeneralIter HEATTRANSFER ThermalMass HFUEL No socket available HX_QE No socket available INSTRUMENT_MEASCALC no socket available INSTRUMENT_MEASADJ RecoveryFactor INSTRUMENT_MEASADJ RecoveryRatio INSTRUMENT_MEASADJ WireCorrection PROPCT PropCT RAM_RECOVERY GeneralIter RAM_RECOVERY ramRecovery SPLITTER_DP no socket available SWIRL no socket available TDAY TDay TURBINE_EFFICIENCY_MAP TurbineEfficiencyMap TURBINE_HUMIDITY_MAP TurbineHumidityEffects TURBINE_MAP TurbineNeppMap TURBINE_REYNOLDS_EFFECTS TurbineReynoldsEffects VALVE Valve
Pt Actual free stream total pressure with ram recovery
14.696 psia output
PtIsen Actual free stream ideal total pressure w/o ram recovery
14.696 psia output
Pt_cmd Demand free stream total pressure 14.696 psia output
Pvapor Actual static vapor pressure at saturate conditions
14.696 psia output
Ts Actual free stream static temperature 518.67 R output
TsDay Temperature day(TDay) reference free stream static temperature
518.67 R output[*]
TsSTD Standard Atmosphere free stream static temperature
518.67 R output
Ts_cmd Demand free stream static temperature
518.67 R output
Ts_max Maximum free stream static temperature
1000 R output[*]
Ts_min Minimum free stream static temperature
0 R output[*]
Tt Actual free stream total temperature 518.67 R output
Tt_cmd Demand free stream total temperature
518.67 R output
VIAS Actual free stream indicated air speed
0 ft/sec output
VIAS_cmd Demand free stream indicated air speed
0 ft/sec output
VIAS_max Maximum free stream indicated air speed
10000 ft/sec output[*]
VIAS_min Minimum free stream indicated air speed
-10000 ft/sec output[*]
VIASprint Applies roundoff to VIAS, for display purposes only, do not use in calculation - see VIASprintRef
0 none output
VIASprintRef Roundoff reference for printing VIAS
1e-05 none output
VTAS Actual free stream true air speed 0 ft/sec output
VTAS_cmd Demand free stream true air speed 0 ft/sec output
VTAS_max Maximum free stream true air speed 10000 ft/sec output[*]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-7
VTAS_min Minimum free stream true air speed -10000 ft/sec output[*]
VTASprint Applies roundoff to VTAS, for display purposes only, do not use in calculation - see VTASprintRef
0 none output
VTASprintRef Roundoff reference for printing VTAS
1e-05 none output
W Actual weight flow 0 lbm/sec output
WAR Actual water-to-air ratio 0 lbm/lbm output
WAR_cmd Demand water-to-air ratio 0 lbm/lbm output
WARmax User input maximum water-to-air ratio
1 lbm/lbm input
WARsat Actual saturated water-to-air ratio 0 lbm/lbm output
W_cmd Demand weight flow 0 lbm/sec output
Wc Actual corrected weight flow 0 lbm/sec output
ZMN User input free stream Mach number - see switchSIM
0 none input by default inactive when switchSIM=ALDTVT, ALDTVI, ALTTVI, PSTTPT, PSTSTT
ZPs User inputfree stream static pressure - see switchSIM
14.696 psia input by default inactive when switchFlightEnvelope=OFF, ON inactive when switchSIM=ALDTMN, ALDTVT, ALDTVI, ALTSMN, ALTTMN, ALTTVI, PTTTMN inactive when switchWAR=WAR, RELHUM, FAR25
ZPt User input free stream total pressure - see switchSIM
14.696 psia input by default inactive when switchFlightEnvelope=OFF, ON inactive when switchSIM=ALDTMN, ALDTVT, ALDTVI, ALTSMN, ALTTMN, ALTTVI, PSTSMN, PSTTMN, PSTSTT inactive when switchWAR=WAR, RELHUM, FAR25
ZTs User input free stream static temperature - see switchSIM
518.67 R input by default inactive when switchFlightEnvelope=OFF, ON inactive when switchSIM=ALDTMN, ALDTVT, ALDTVI, ALTTMN, PSTTMN, PSTTPT, PTTTMN inactive when switchWAR=WAR, RELHUM, FAR25
ZTt User input free stream total temperature - see switchSIM
518.67 R input by default inactive when switchFlightEnvelope=OFF, ON
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-8
inactive when switchSIM=ALDTMN, ALDTVT, ALDTVI, ALTSMN, ALTTVI, PSTSMN inactive when switchWAR=WAR, RELHUM, FAR25
ZVIAS User input free stream indicated air speed - see switchSIM
0 ft/sec input by default inactive when switchFlightEnvelope=OFF, ON inactive when switchSIM=ALDTMN, ALDTVT, ALTSMN, ALTTMN, PSTSMN, PSTTMN, PSTTPT, PSTSTT, PTTTMN inactive when switchWAR=WAR, RELHUM, FAR25
ZVTAS User input free stream true air speed - see switchSIM
0 ft/sec input by default inactive when switchFlightEnvelope=OFF, ON inactive when switchSIM=ALDTMN, ALDTVI, ALTSMN, ALTTMN, ALTTVI, PSTSMN, PSTTMN, PSTTPT, PSTSTT, PTTTMN inactive when switchWAR=WAR, RELHUM, FAR25
ZW User input weight flow 0 lbm/sec input
ZWAR User input water-to-air ratio - see switchWAR
0 lbm/lbm input by default inactive when switchWAR=RELHUM, FAR25
Zalt User input pressure altitude - see switchSIM
0 ft input by default inactive when switchSIM=PSTSMN, PSTTMN, PSTTPT, PSTSTT, PTTTMN
ZdTs User input deviation from standard ambient temperature - see switchSIM
0 dF input by default inactive when switchSIM=ALTSMN, ALTTMN, ALTTVI, PSTSMN, PSTTMN, PSTTPT, PSTSTT, PTTTMN
ZeRam User input ram recovery of free stream - see switchRam
1 none input
ZrelHum User input relative humidity (%) - see switchWAR
0 none input by default inactive when switchFlightEnvelope=OFF, ON inactive when switchSIM=ALDTMN, ALDTVT, ALDTVI, ALTSMN, ALTTMN, ALTTVI, PSTSMN, PSTTMN, PSTTPT, PSTSTT, PTTTMN inactive when switchWAR=WAR, FAR25
* If the Socket is empty, the IO Status is input (see Sockets)
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-11
Option Variables
Variable Description Variables IOStatus Affected
Default Allowed Values
switchFlightEnvelope Flight Envelope Limiting switch indicator [ OFF / ON ] OFF - allows operation outside of flight envelope - performance and operability may not be guaranteed ON - limits operation inside a flight envelope
ZPs, ZPt, ZTs, ZTt, ZVIAS, ZVTAS, ZrelHum
OFF OFF, ON
switchGuess First guess switch indicator [ ON / OFF ] None ON ON, OFF
switchRam switchRam allows different ways to handle Free stream Ram Recovery Note: Ram recovery is NOT Inlet recovery -----------|-----|-------|--------| switchRam | NUM | ZeRam | eRam | -----------|-----|-------|--------| UNITY | 1 | | | CONSTANT | 2 | X | | USER | 3 | | X | USER indicates that the element will try -----------|-----|-------|--------| to use the S_rec socket to determine eRam
eRam UNITY UNITY, CONSTANT, USER
switchSIM The switchSIM allows the user to specify the ambient conditions based on any three of the following parameters. Which three inputs are active depend on the switchSIM setting. -----------|-----|------|-----|-------|-------|-----|-----|------|-----|-----| switchSIM | SIM | Zalt | ZMN | ZVIAS | ZVTAS | ZPs | ZTs | ZdTs | ZTt | ZPt | -----------|-----|------|-----|-------|-------|-----|-----|------|-----|-----| ALDTMN | 1 | X | X | | | | | X | | | ALDTVT | 5 | X | | | X | | | X | | | ALDTVI | 6 | X | | X | | | | X | | | ALTSMN | 12 | X | X | | | | X | | | | ALTTMN | 3 | X | X | | | | | | X | | ALTTVI | 8 | X | | X | | | | | X | | PSTSMN | 11 | | X | | | X | X | | | | PSTTMN | 9 | | X | | | X | | | X | | PSTTPT | 13 | | | | | X | | | X | X | PSTSTT | 2 | | | | | X | X | | X | | PTTTMN | 10 | | X | | | | | | X | X | -----------|-----|------|-----|-------|-------|-----|-----|------|-----|-----| Note that the numerical code for simSwitch does not include options for 4 and 7. These are left blank to preserve the historical numbering scheme.
switchWAR Humidity input selection -----------|-----| switchWAR | NUM | -----------|-----| WAR | 1 | Use ZWAR RELHUM | 2 | Use ZRELHUM FAR25 | 25 | Use FAR25 schedule -----------|-----|
ZPs, ZPt, ZTs, ZTt, ZVIAS, ZVTAS, ZrelHum, ZWAR
WAR WAR, RELHUM, FAR25
switchWhereSolved Determines if the independents and dependents are handled by the local solver or promoted to the assembly solver
None LOCAL LOCAL, EXTERNALLY
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-12
Functions
Prototype Description
real TB_FAR25Hum (real dTs) None
real TB_WARmax (real alt, real MN, real Ts) None
void VCinit () None
void ambient () Performs the engineering calculations. The solver will keep calling this function (through the iteratedFunction) until the active Dependents are converged.
void calculate ()
Controls what happens when Ambient elements are called to execute by their parent. In this type of element the actual engineering calculations are not done directly in the calculate(). Instead this function determines if the Solver contained in this element should be used to iterate independent parameters to solve the dependencies.
real getAlt (real pamb) Retrieve the altitude for a given ambient pressure
real getPsGuess (real alt_cmd_local) Static pressure guessing utility
real getPvapor (real T) Retrieve vapor pressure from temperature
void getRam () Retrieve the global variable eRam
real getTsSTD (real pamb) Retrieve static temperature from ambient pressure
real getVIAS (real xm, real p0, real pamb, real gamb, real ramb)
Retrieve indicated air speed from Mach number, isentropic total pressure, static pressure, gamma and R
real getVTAS (real xm, real tamb, real gamb, real ramb) Retrieve true air speed from Mach number, static temp, gamma, and R
real get_MNprint () Related to MNprint
real get_VIASprint () Related to VIASprint
real get_VTASprint () Related to VTASprint
real get_altPrint () Related to altPrint
real get_dTsPrint () Related to dTsPrint
void guesses () Perform initial guesses Done by assuming constant gamma of 1.4 adjusted for MN.
void set_MNprint (real userValue) Related to MNprint
void set_VIASprint (real userValue) Related to VIASprint
void set_VTASprint (real userValue) Related to VTASprint
void set_altPrint (real userValue) Related to altPrint
void set_dTsPrint (real userValue) Related to dTsPrint
void variableChanged (string name, any oldVal) None
S_TDay Deviation from standard ambient temperature
TDAY TsDay
S_rec Free stream ram pressure recovery socket
RAM_RECOVERY eRamBase
Independents
Name Description Default Active When
ind_MN Varies ambient Mach number MN Manual
ind_PtIsen Varies ambient total pressure PtIsen Manual
ind_Tt Varies ambient total temperature Tt Manual
ind_WAR Varies ambient water-to-air ratio WAR Manual
Dependents
Name Description eq_lhs eq_rhs Active When
dep_FAR25Hum Drives relHum to FAR25 value with a WARmax limit
0.01*relHum*WARsat 0.01*FAR25Hum*WARsat Manual
dep_MN Drives Mach number to demand value _MN2 _MN2cmd Manual
dep_MNmax Limits Mach number to maximum value _MN2 _MN2max Manual
dep_MNmin Limits Mach number to minimum value _MN2 _MN2min Manual
dep_Ps Drives static pressure to demand value Fl_O.Ps Ps_cmd Manual
dep_Pt Drives total pressure to demand value Fl_O.Pt Pt_cmd Manual
dep_Ts Drives static temperature to demand value Fl_O.Ts Ts_cmd Manual
dep_TsMax Limits static temperature to maximum value
Fl_O.Ts Ts_max Manual
dep_TsMin Limits static temperature to minimum value
Fl_O.Ts Ts_min Manual
dep_Tt Drives total temperature to demand value Fl_O.Tt Tt_cmd Manual
dep_VIAS Drives VIAS to demand value _VIAS2 _VIAS2cmd Manual
dep_VIASmax Limits VIAS to maximum value _VIAS2 _VIAS2max Manual
dep_VIASmin Limits VIAS to minimum value _VIAS2 _VIAS2min Manual
dep_VTAS Drives VTAS to demand value _VTAS2 _VTAS2cmd Manual
dep_VTASmax Limits VTAS to maximum value _VTAS2 _VTAS2max Manual
dep_VTASmin Limits VTAS to minimum value _VTAS2 _VTAS2min Manual
dep_WAR Drives WAR to demand value with saturation, WARmax and zero WAR limits
WAR WAR_cmd Manual
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-14
dep_WARmax Limit WAR to WARmax WAR WARmax Manual
dep_WARmin Limits WAR to 0.0 WAR 0.0 Manual
dep_WARsat Limit WAR to the saturation value WAR WARsat Manual
dep_alt Drives altitude to demand value alt alt_cmd Manual
dep_altMax Limits altitude to maximum value alt alt_max Manual
dep_altMin Limits altitude to minimum value alt alt_min Manual
dep_dTs Drives temperature delta to demand value dTs dTs_cmd Manual
dep_dTsMax Limits temperature delta to maximum value
dTs dTs_max Manual
dep_dTsMin Limits temperature delta to minimum value dTs dTs_min Manual
dep_relHum Drives relHum to demand value with saturation, WARmax and zero WAR limits
0.01*relHum*WARsat 0.01*relHum_cmd*WARsat Manual
dep_relHumMax Limit relative humidity to 100% 0.01*relHum 1.0 Manual
Other Objects
Name Type Description
constraintAlt ConstraintGroup
constraintPs ConstraintGroup
constraintSpeed ConstraintGroup
constraintTemp ConstraintGroup
solver Solver Balances out independent and dependents to determine the ambient conditions.
Usage Notes
Ambient is a class Element that: - Determines the free stream flow conditions. The flow conditions can be set any number of ways, depending on the user settings: ( see - switchSIM.description, switchRam.description, switchWAR.description ) - Contains a Solver that internally solves a particular flight condition. The Solver is set up automatically, based on Option variables, that trigger the variableChanged function. The ambient function is called until all of the solver dependents are satisfied. There is also a guess function used to get guesses at PtIsen, Tt, MN and WAR. It is also possible to have the independents and dependents thrown to a higher level solver (set switchWhereSolved to 'EXTERNALLY'). - There is a socket available for setting the free stream ram recovery. This recovery represents the pressure loss going from the free stream to the inlet entrance. An example of this loss would be an external shock loss. The actual inlet loss should be handled external/after this element. - The user can specify vitiated air by defining the fuel properties that are to have been mixed and burned with the air. - The atmospheric properties are defined by U.S. Standard Atmosphere 1962.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-15
The user can modify Atmosphere data: ( _alttab, _tstdtab, _tccctab, _pccctab, _pambtab } The user can modify the source that uses Atmosphere data: ( getAlt, getTsSTD ) Caution: If you have a S_TDay object, its standard Ts must be consistent with the Standard Atmosphere Definition. - The polynomial coefficients used for Pvaper function are from Ashrae Handbook of Fundamentals, 1989, P.6.6 The user can modify the Water and Ice data: ( _Cice, _Cwater) ( getPvapor) - The R and Gamma defaults for speed of sound calculation are used only with VIAS calculation, and are from ( _cra, _gamd,)
Ambient has a baseType of Element.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-16
[ Back to Index ]
2.3 AmbientNASA
Software Release: NPSS_1.6.4 - Rev: N Document Generation Date: 10/20/06 AMBIENT ELEMENT ----------------------- | | | AMBIENT | | | ----------------------- | V socket: S_customDay socketType: TDAYCUSTOM returns: TsDay AmbientNASA will calculate flight condition properties
Variables
Variable Description Default Units IO Status
C_ASTD2 Speed of sound at standard conditions, squared
1.24677e+06 ft2/sec2 const
C_FtoR Conversion constant: F to R 459.67 R const
C_GAMSTD Gamma at standard conditions 1.40052 none const
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
Fl_Amb FlowStation Ambient flow station
Sockets
Socket Description socketType Sets Values
S_customDay Custom socket for setting TsDay, day temperature TDay TsDay
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-20
Independents
Name Description Default Active When
ind_MN MN independent for internal solver MN Manual
ind_Ps Ps independent for internal solver Ps_in Manual
ind_Ts Ts independent for internal solver Ts_in Manual
ind_gam gams independent for internal solver gam_guess Manual
Dependents
Name Description eq_lhs eq_rhs Active When
dep_Pt Pt dependent for internal solver Pt Pt_in Manual
dep_Tt Tt dependent for internal solver Tt Tt_in Manual
dep_gam gams dependent for internal solver Fl_Amb.gams gam_guess Manual
Other Objects
Name Type Description
solvAmb Solver Internal solver to determine flight conditions
Usage Notes
The Ambient element defines flight condition properties: - altitude (alt) - ambient pressure (Ps) - ambient temperature (Ts) - delta temperature from selected atmosphere (dTs) - Mach Number (MN) - calibrated airspeed (VCAS) - equivalent airspeed (VEAS) - true airspeed (VTAS) - total flight conditions pressure (Pt) - total flight conditions temperature (Tt) - relative humidity (humRel) - specific humidity (humSp) - dynamic pressure or velocity head (q)
Background Date Author Description -------- --------------------- ------------------------------------- 06/02/06 R Ashleman Additions to conform with 5571 revision Day temp tables added from ARP210 04/11/06 R Ashleman Corrections 02/28/05 R. Ashleman Combined P&W and GE functions into common code. 08/24/04 B. Mao Update switchMode description. 07/21/04 B. Mao Set dep_Pt.eq_Ref. 05/04/04 Igor Fuksman SAE S15 ARP5571 Draft 4 revisions 03/12/04 B. Mao Fixing a few incorrect comments. 02/26/04 Igor Fuksman Added VEAS input and output capability, including new switchSim options for it Moved variables and functions to be consistent with conventional structure
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-21
Renamed MNuse2VIASuse to MNuse_to_VIASuse 07/23/03 T. Del Vecchio Added an input option B. Mao 'Pamb_Tamb_Pt1_Tt1=22011' to handle special situations in data reduction. If Pamb>Pt1, MN is negative. Revised MNuse2VIASuse() to handle negative MN. 04/10/03 B. Mao Replaced setTotalStaticTP by setTotalTsPsMN. 04/09/03 Douglas L. Baker Corrected ESI numbering scheme to match NASA standard (purpose)(category)(owner) 08/22/02 Igor Fuksman Added FAR25 humidity option for switchHum (data is taken from FARHUM SOAPP subroutine) 03/26/02 Brian Mao Major revision. Replaced Secant solver by N-R solver. Optimized code and fixed bugs in Standard atmosphere calculation. Made constant arrays and tables attributes of class instead of local variables to avoid re-initialization. Devised encoding and decoding logic for switchSim options. Rewrote calculate() function logic. Cut code size from 2500 lines to 1100 lines. Speed improved by a factor of 1.4 to 3.8, depending on switchSim option. 12/03/01 Igor Fuksman Added flight conditions envelope socket for calculation of newly defined Take-Off and Flight envelope flags Make warning/error calls non-provisional because the logic is only called on the 1st pass and provisional warnings/errors will not be set properly 09/13/01 Igor Fuksman Created original AmbientNASA has a baseType of Element.
The Bleed element allows the user to extract bleed flows from the main stream, or reintroduce existing bleed flows into the main stream. The element can also be used to transfer heat to or from a sink. A heat transfer subelement can be used if desired.
Variables
Variable Description Default Units IO Status
Qhx Heat transfer to sink (+) or returned to main fluid stream (-). 0 Btu/sec output[*]
Wref Weight flow that bleed fractions are referenced to 0 lbm/sec output
WrefName Location of the reference bleed flow (string variable) none input
bleedInPortList List of bleed in ports (created by user in model) { } none output
bleedOutPortList List of bleed out ports (created by user in model) { } none output
* If the Socket is empty, the IO Status is input (see Sockets)
Functions
Prototype Description
void calculate () None
void postcreate (string name) None
int verify () None
Ports and Internal Stations
Port/Station Type Description
Fl_tmp FlowStation Temporary flow station
Fl_I FluidInputPort Primary incoming flow.
Fl_O FluidOutputPort Primary exiting flow.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-23
Name at runtime BleedInPort set at runtime
Name at runtime BleedOutPort set at runtime
Sockets
Socket Description socketType Sets Values
S_Qhx Heat transfer socket. HEATTRANSFER Qhx
Usage Notes
Bleed No Provisional Errors or Warnings - Any number of bleed outflow or inflow ports can be created on a Bleed element. - Bleed inflows are mixed with the main stream so as to preserve total mass flow and total energy, but no momentum calculations are performed. - Bleed flows are expressed as a fraction of a reference flow. The flow to be used as the reference flow is specified by the string variable WrefName. If this string is left blank, the element inlet flow is used as the reference flow.
Bleed has a baseType of Element.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-24
[ Back to Index ]
2.5 BleedOut BleedOutputPort (0 to n) ^ | ----------------------- | | | | Fl_I --->| BleedOut |---> Fl_O | baseType = Element | | | ----------------------- | | | socket: S_map socketType: BLEED_MAP returns: s_P,s_h,s_T, switchEnergy socket: S_+ Name of Port socketType: BLEED_FLOW returns: WqReturn BleedOut allows the user to extract bleed flows a flow stream.
Variables
Variable Description Default Units IO Status
BleedOutputPortList List of bleed ports { } none output
RefPortInName Name of fluid port to use for reference flow conditions none input
WqWrefSum Sum of bleed output flow fractions 0 none output
Wsum Sum of bleed output flow 0 lbm/sec output
allowedValues default value allowed for socket created at run time { "_WqReturn" }
none unset
s_P Sets bleeds source pressure as a fraction/scalar of the input port value
1 none output[*]
s_T Sets bleeds source temperature as a fraction/scalar of the input port value
1 none output[*]
s_h Sets bleeds source enthalpy as a fraction/scalar of the input port value
BleedOut - This element has a standard input and output fluid port that allow it to be plugged into a flowstream. Once it is plugged in, the user can request any number of bleeds be taken out at run time. - The bleed flow fraction can be referenced to any station flow in the model by naming the station in RefPortInName. If this name is not input, then the flow fractions are referenced to incoming flow. - This element allows the bleed conditions to be specified as a fraction of incoming pressure (s_P) and enthalpy (s_h) or temperature (s_T) (controlled by switchEnergy). These values can also be calculated by a subelement plugged into the S_map socket. - The user can request any number of bleed ports be added at run time by asking the element for an additional BleedOutputPort. - When the user requests a new BleedOutputPort be created the following things happen: 1) A new BleedOutputPort is created.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-26
2) A socket S_ is created that allows the user to plug in a subelement to calculate the bleed flow. If this socket is empty then the flow fraction is input directly as .Wq.
BleedOut has a baseType of Element.
[ Back to Index ]
2.6 BleedOutInterstage
BleedOutputPort (0 to n) ^ | ----------------------- | | | | Fl_I --->| BleedOutInterstage |---> Fl_O | baseType = Element | | | ----------------------- | | | V | Sh_O | | socket: S_map socketType: BLEED_MAP returns: dPqdP,dhqdh,dTqdT, switchEnergy socket: S_+ Name of Port socketType: BLEED_FLOW returns: _WqReturn BleedOutInterstage allows the user to create a location that simulates a compressor interstage bleed allowing for multiple bleeds to be extracted.
Variables
Variable Description Default Units IO Status
BleedOutputPortList List of bleed ports { } none output
RefPortInName Name of fluid port to use for upstream reference, downstream uses Fl_I
unset
WqWrefSum Sum of bleed output flow fractions 0 none output
Wsum Sum of bleed output flow 0 lbm/sec output
allowedValues default value allowed for socket created at run time { "_WqReturn" }
none unset
dPqdP Pressure fraction for bleed source. 1 none output[*]
dTqdT Temperature fraction for bleed source. 1 none output[*]
dhqdh Enthalpy fraction for bleed source. 1 none output[*]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-27
pwr Power returned to shaft due to not compressing bleed flow 0 hp output
BleedOutInterstage - This element is designed to work with a standard compressor. The user inputs a value for the RefPortInName that corresponds to the compressor input. The bleed flow fractions are input in terms of the reference port, which represents the thermodynamic conditions at the compressor entrance, and the input conditions to the element, which is assumed to represent the thermodynamic conditions at the compressor exit. - This element is designed to represent a bleed location on a compressor. To represent more than one bleed source, line these elements up, one source after another. - The bleeds created using this element are mathematically the same as the ports created inside the compressor. Creating them in here allows the source pressure and temperature fractions to be determined once
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-28
using a subelement. This is easier on the user, since he/she does not have to specify the bleed conditions again and again for bleeds coming from the same source. - This element has a standard input and output FluidPort that allow it to be plugged into a flowstream. Once it is plugged in, the user can request any number of bleeds be taken out at run time. - This element allows the bleed conditions to be specified as a fraction of compressor pressure rise (dPqdP) and enthalpy rise (dhqdh) or temperature rise (dTqdT) (controlled by switchEnergy). These values can also be calculated by a subelement plugged into the S_map socket. - The user can request any number of bleed ports be added at run time by asking the element for an additional BleedOutputPort. - This element has a ShaftOutputPort (Sh_O) that must be hooked up to the same shaft as the compressor. The element calculates a torque that represents the work not done by the compressor because the bleed flow was not completely compressed (the compressor assumed that it was). - When the user requests a new BleedOutputPort be created the following things happen: 1) A new BleedOutputPort is created. 2) A socket S_ is created that allows the user to plug in a subelement to calculate the bleed flow. If this socket is empty then the flow fraction is input directly as .Wq
WfuelLast Previous combustor fuel flow - for loop only
0 lbm/sec input
WfuelNew Next combustor fuel flow - for loop only
0 lbm/sec input
a_dPqP Duct friction pressure drop adder 0 none input
a_dPqPAud Audit factor adder applied to pressure ratio
0 psia unset by default input when switchAud=AUDIT inactive when switchAud=BASE
a_dPqPaud 0 none input
a_eff Adiabatic efficiency adder 0 none input
a_effChem Chemical efficiency adder 0 none input
countFuel Fuel loop counter 0 output
countFuelMax Fuel loop maximum counter 50 input
countRayleigh Rayleigh loop counter 0 output
countRayleighMax Rayleigh loop maximum counter 25 input
dPqP Adjusted duct friction pressure drop
0 none output
dPqPBase Duct friction pressure drop 0 none output[*]
dPqPRayleigh Adjusted Rayleigh pressure drop 0 none input by default output when switchHotLoss=CALCULATE
eff Adjusted adiabatic burner efficiency
1 none output
effBase Adiabatic burner efficiency, from socket
1 none output[*]
effChem Adjusted chemical efficiency 1 none input
effChemBase Chemical efficiency, from socket 1 none output[*]
flagRayleighChoked If true, Rayleigh loop results in supersonic flow
0 output
flagRayleighLossTooMuch If true, Rayleigh loop results in too much loss
0 output
fuelFractV Fraction of the incoming flow velocity fuel enters the burner
0 none input
s_dPqP Duct friction pressure drop scalar 1 none input
s_dPqPAud Audit factor scalar applied to pressure ratio
1 none unset by default input when switchAud=AUDIT
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-31
inactive when switchAud=BASE
s_dPqPaud 1 none input
s_eff Adiabatic efficiency scalar 1 none input
s_effChem Chemical efficiency scalar 1 none input
tolRayleigh Iteration tolerance on momentum pressure drop
4e-05 none input
tolWfuel Iteration tolerance on temperature burn
1e-05 none input
* If the Socket is empty, the IO Status is input (see Sockets)
Option Variables
Variable Description Variables IOStatus Affected
Default Allowed Values
switchAud Determines if the audit factors are used a_dPqPAud, s_dPqPAud
BASE BASE, AUDIT
switchBurn Switch determines if burner is running to fuel flow, FAR, or T4. Setting option to FUEL will burn using the burner value as an input. Setting the option to WFUEL will burn using the value coming in from the fuel station.
The burner element performs high level burner performance calculations. This element works with an entrance fluid and fuel stream. It mixes the two flows together and then performs the burn calculations. Please note that the burner has no control over the actual fuel stream conditions--fuel type, LHV, etc. These values are properties of the fuel flow itself and are usually set in the FuelStart element. There are three ways to specify the burner exit conditions. The first way is specify the burner fuel-to-air ratio. The second way is to set the burner fuel flow. The third way is to set the burner exit temperature. The type of input used is controlled by an option switch. The burner tracks several different pressure losses. The first, dPqP, accounts for duct friction pressure drops. The second, dPqPRayleigh, accounts for the Rayleigh pressure drop. dPRayleigh is input or calculated - see switchHotLoss, an iteration is necessary since the pressure loss itself is a function of the exit conditions. The burner also allow two efficiencies to be input. The first efficiency, eff, refers to the efficiency based on enthalpy change. The second efficiency, effChem, refers to the efficiency based on temperature change. Both terms can be input. However, the enthalpy efficiency is always applied first. Additionally, the user can request a pre burner pressure loss dPqP. The pressure loss calculations are performed before all the other calculations are done. This means that the combustion entrance pressure will not match the value indicated by the burner entrance. The user can request a heat transfer Qhx. The heat transfer calculations are performed after all the other calculations are
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-33
done. This means that if heat transfer is being used, the exit temperature will not match the value indicated by the burner calculations.
WfuelLast Previous combustor fuel flow - for loop only
0 lbm/sec input
WfuelNew Next combustor fuel flow - for loop only
0 lbm/sec input
a_dPqPf Duct friction pressure drop adder 0 none input
a_dPqPfAud Audit factor adder applied to pressure ratio
0 psia unset
a_eff Adiabatic efficiency adder 0 none input
countFuel Fuel loop counter 0 output
countFuelMax Fuel loop maximum counter 50 input
countRayleigh Rayleigh loop counter 0 output
countRayleighMax Rayleigh loop maximum counter 25 input
dPqP Overall pressure drop 0 none output
dPqPRayleigh Adjusted Rayleigh pressure drop 0 none input by default output when switchHotLoss=CALCULATE
dPqPf Adjusted duct friction pressure drop 0 none output
dPqPfBase Duct friction pressure drop 0 none output[*]
eff Adjusted adiabatic burner efficiency
1 none output
effBase Adiabatic burner efficiency, from socket
1 none output[*]
flagRayleighChoked If true, Rayleigh loop results in supersonic flow
0 output
flagRayleighLossTooMuch If true, Rayleigh loop results in too much loss
0 output
fuelFractV Fraction of the incoming flow velocity fuel enters the burner
0 none input
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-35
s_dPqPf Duct friction pressure drop scalar 1 none input
s_dPqPfAud Audit factor scalar applied to pressure ratio
1 none unset
s_eff Adiabatic efficiency scalar 1 none input
tolRayleigh Iteration tolerance on momentum pressure drop
4e-05
none input
tolWfuel Iteration tolerance on temperature burn
1e-05
none input
* If the Socket is empty, the IO Status is input (see Sockets)
Option Variables
Variable Description Variables IOStatus Affected
Default Allowed Values
switchAud Determines if the audit factors are used None BASE BASE, AUDIT
switchBurn Switch determines if burner is running to fuel flow, FAR, or T4. Setting option to FUEL will burn using the burner value as an input. Setting the option to WFUEL will burn using the value coming in from the fuel station.
The burner element performs high level burner performance calculations. This element works with an entrance fluid and fuel stream. It mixes the two flows together and then performs the burn calculations. Please note that the burner has no control over the actual fuel stream conditions--fuel type, LHV, etc. These values are properties of the fuel flow itself and are usually set in the FuelStart element. There are three ways to specify the burner exit conditions. The first way is specify the burner fuel-to-air ratio. The second way is to set the burner fuel flow. The third way is to set the burner exit temperature. The type of input used is controlled by an option switch. The burner tracks several different pressure losses. The first, dPqP, accounts for duct friction pressure drops. The second, dPqPRayleigh, accounts for the Rayleigh pressure drop. dPRayleigh is input or calculated - see switchHotLoss, an iteration is necessary since the pressure loss itself is a function of the exit conditions. The burner also allow two efficiencies to be input. The first efficiency, eff, refers to the efficiency based on enthalpy change. The second efficiency, effChem, refers to the efficiency based on temperature change. Both terms can be input. However, the enthalpy efficiency is always applied first. Additionally, The user can request a pre burner pressure loss dPqP. The pressure loss calculations are performed before all the other calculations are done. This means that the combustion entrance pressure will not match the value indicated by the burner entrance. The user can request a heat transfer Qhx. The heat transfer
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-37
calculations are performed after all the other calculations are done. This means that if heat transfer is being used, the exit temperature will not match the value indicated by the burner calculations.
Background Date Author Description -------- --------------------- ------------------------------------- 06/02/06 R Ashleman Additions to conform with 5571 revision Day temp tables added from ARP210 04/11/06 R Ashleman Corrections 02/28/05 R. Ashleman Combined P&W and GE functions into common code. 08/24/04 B. Mao Update switchMode description. 07/21/04 B. Mao Set dep_Pt.eq_Ref. 05/04/04 Igor Fuksman SAE S15 ARP5571 Draft 4 revisions 03/12/04 B. Mao Fixing a few incorrect comments. 02/26/04 Igor Fuksman Added VEAS input and output capability, including new switchSim options for it Moved variables and functions to be consistent with conventional structure Renamed MNuse2VIASuse to MNuse_to_VIASuse 07/23/03 T. Del Vecchio Added an input option B. Mao 'Pamb_Tamb_Pt1_Tt1=22011' to handle special situations in data reduction. If Pamb>Pt1, MN is negative. Revised MNuse2VIASuse() to handle negative MN. 04/10/03 B. Mao Replaced setTotalStaticTP by setTotalTsPsMN. 04/09/03 Douglas L. Baker Corrected ESI numbering scheme to match NASA standard (purpose)(category)(owner) 08/22/02 Igor Fuksman Added FAR25 humidity option for switchHum (data is taken from FARHUM SOAPP subroutine) 03/26/02 Brian Mao Major revision. Replaced Secant solver by N-R solver. Optimized code and fixed bugs in Standard atmosphere calculation. Made constant arrays and tables attributes of class instead of local variables to avoid re-initialization. Devised encoding and decoding logic for switchSim options. Rewrote calculate() function logic. Cut code size from 2500 lines to 1100 lines. Speed improved by a factor of 1.4 to 3.8, depending on switchSim option. 12/03/01 Igor Fuksman Added flight conditions envelope socket for calculation of newly defined Take-Off and Flight envelope flags Make warning/error calls non-provisional because the logic is only called on the 1st pass and provisional warnings/errors will not be set properly 09/13/01 Igor Fuksman Created original BurnerNASA has a baseType of Element.
[ Back to Index ]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-38
2.9 Compressor
Software Release: NPSS_1.6.4 - Rev: AI Document Generation Date: 01/08/08
The Compressor element performs high-level compressor performance calculations. The performance can either be calculated in terms of efficiency or temperature ratio. This element is usually used with a map subelement.
Variables
Variable Description Default Units IO Status
Nc Corrected speed 0 rpm output
NcDes Design point corrected speed 0 rpm unset by default input when switchDes=OFFDESIGN output when switchAud=BASE, AUDIT output when switchDes=DESIGN output when switchMap=NONE, EFF, TR
NcPct Percent corrected speed 0 none output
NcqNcDes Ratio of current corrected speed to design corrected speed
Qhx Heat transfer absorbed by (+) or returned from (-) metal mass
0 Btu/sec output[*]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-39
SMN Stall margin at constant speed 0 none output[*]
SMW Stall margin at constant flow 0 none output[*]
TR Temperature ratio 0 none output[*]
TRdes Temperature ratio at design 0 none unset by default input when switchDes=OFFDESIGN output when switchAud=BASE, AUDIT output when switchDes=DESIGN output when switchMap=NONE, EFF, TR
WbldSum Total bleed weight flow 0 lbm/sec output
Wc Corrected flow based on inlet conditions 0 lbm/sec output
WcBase Corrected Flow, before audit factors are applied
0 lbm/sec output[*]
WcCalc Corrected flow into compressor (from map)
0 lbm/sec output
WcDes Corrected flow at design based on inlet conditions
0 lbm/sec unset by default input when switchDes=OFFDESIGN output when switchAud=BASE, AUDIT output when switchDes=DESIGN output when switchMap=NONE, EFF, TR
WcqWcDes Cycle Corrected flow ratio, relative to design
0 none output
a_WcAud Corrected weight flow audit adder 0 lbm/sec unset by default inactive when switchAud=BASE, AUDIT inactive when switchDes=DESIGN, OFFDESIGN inactive when switchMap=NONE, EFF, TR
a_effAud Audit factor adder applied to adiabatic efficiency
0 none unset by default inactive when switchAud=BASE, AUDIT inactive when switchDes=DESIGN, OFFDESIGN inactive when switchMap=NONE, EFF, TR
bleedPortList list for the user supplied objects { } unset
Compressor - The compressor performance is determined by pressure ratio (PR) and either efficiency (eff) or temperature ratio (TR) as defined by switchMap (switchMap is set by the map subelement). If the map subelement is empty then the performance is determined by setting pressure ratio and efficiency. - Audit factors are available for adjusting the map values of efficiency
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-41
and weight flow. The weight flow audit factor is applied after the map is run. The subelement dependent must point to the audited corrected weight flow for the element to work right with the audit taken into account. Audit factors are used when the switchAud Option Switch is set to AUDIT. Use of Audit factors: variable = s_variableAud * varibleBase + a_variableAud - Solver independents and dependents are contained in the compressor map subelement (CompressorMap or CompTempSub). There are no solver terms required if a compressor map is not used. The solver will drive the scaled map corrected weight flow (including audit scalers if they are used) to equal the corrected compressor inlet flow. - Any number of BleedInterStageOutPorts can be requested at run time. The weight flow fraction, work fraction, and pressure fraction are input directly into this port which then determines the bleed exit conditions. - effPoly is an output only variable. To input effPoly in design point set effDes as a solver independent and form a solver dependent of the difference between effPoly and the desired value. - The compressor inertia is stored in the ShaftOutputPort. If the user wishes to set the inertia he/she should set it directly in the port (Sh_O.inertia). - The mechanical speed is passed from the shaft through the mechanical port (Sh_O.Nmech).
ControlVolume - This element will act as a mass storage element. During transients, it uses the time derivative of incoming pressure to determine the amount of mass stored in the volume. During steady state, it just passes the inlet flow to the exit station. To run this element, all a user needs to do is to specify a volume.
Fl_IV FlowStation Temporary flow station for the input to the valve subelement
Fl_OV FlowStation Temporary flow station for the output of the valve subelement
Fl_I1 FluidInputPort Fluid Input Port
Fl_I2 FluidInputPort Fluid Input Port
Fl_O1 FluidOutputPort Fluid Output Port
Fl_O2 FluidOutputPort Fluid Output Port
Sockets
Socket Description socketType Sets Values
S_vW Calculates the amount of flow through the valve. VALVE Wvalve
Usage Notes
CrossOverValve - This is a Crossover Valve element which allows the controlled flow of fluid from one stream to another through a valve. The crossover flow is calculated in a subelement. - This element has two input ports and two output ports. It also has two internal flow stations that represent the entrance to and exit from the valve. These stations represent the flow that goes from one side of the valve to another. - It is important to note that the valve can either be bi-directional or uni-directional. If the valve is bi-directional, then flow can go in either direction as driven by the pressure. If the flow is uni-directional, then the flow will only flow in one direction. If the pressures dictate that the flow should move in the other direction, then there is no flow.
EPR_denName Name of EPR denominator path - element.FS or alias FS none input
EPR_numName Name of EPR numerator path - element.FS or alias FS none input
FPR Fan pressure ratio 0 none output
FPR_denName Name of FPR denominator path - element.FS or alias FS none input
FPR_numName Name of FPR numerator path - element.FS or alias FS none input
OPR Engine overall pressure ratio 0 none output
_calcEPR unset
_calcFPR unset
_ptrBPR INTERNAL USE ONLY: reference for BPR none unset
_ptrEPRden INTERNAL USE ONLY: reference for EPR denominator none unset
_ptrEPRnum INTERNAL USE ONLY: reference for EPR numerator none unset
_ptrFPRden INTERNAL USE ONLY: reference for FPR denominator none unset
_ptrFPRnum INTERNAL USE ONLY: reference for FPR numerator none unset
_ptrPt0 INTERNAL USE ONLY: reference for Pt0 none unset
_ptrPt3 { } unset
Functions
Prototype Description
void VCinit () None
void calculate () None
int verify () None
Usage Notes
CycleNASA - This element calculates engine cycle parameters BPR, EPR, FPR, and OPR. - This element needs only to be included in the model; there is no linkage required. It should be the included at the end of the solver sequence. - BPR: element assumes a bypass fan engine and that the bypass ratio is defined by the first splitter in the solver sequence.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-46
- EPR and FPR require user inputs for the locations where pressures are found to use in the ratiosr: EPR = (EPR_numName + .Pt) / (EPR_denName + .Pt) FPR = (FPR_numName + .Pt) / (FPR_denName + .Pt) The strings for the numerator and denominator are user input. These may either be paths to the flow stations or the alias flow station names. Examples: EPR_numName = "CmpH.Fl_O" or EPR_denName = "F01" Including ".Pt" in these strings will cause an error.
Background Date Author Description -------- --------------------- ------------------------------------- 07/18/06 R. Ashleman Created as result of ARP5571 CycleNASA has a baseType of Element.
S_dP Calculates dPqP, the scaled pressure drop. DPDIFFUSER dPqP
Usage Notes
Diffuser - This element calculates the pressure loss in a diffuser. The exit conditions are determined by applying the pressure loss to the inlet conditions and keeping a constant enthalpy. Additionally, the incoming swirl is adjusted by a user supplied swirl attenuation ratio. The main difference between this element and a standard duct is that the pressure loss is a function of the diffuser area ratio.
Diffuser has a baseType of Element.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-48
[ Back to Index ]
2.14 Duct
Software Release: NPSS_1.6.4 - Rev: AI Document Generation Date: 01/08/08
The Duct element performs a simple adiabatic pressureloss calculation. The pressure loss is calculated by the S_dP socket (or input by the user if this socket is empty). The duct maintains a constant enthalpy while the pressure loss is applied.
Variables
Variable Description Default Units IO Status
a_dPqP Adder on normalized pressure drop (delta P/P) 0 none input
a_dPqPaud Adder on audit normalized pressure drop 0 none inactive
dP Scaled pressure drop (delta P) 0 psia output
dPqP Scaled normalized pressure drop (delta P/P) 0 none output
dPqP_in User input value of dPqP will override dPqP if not zero. If it is zero then dPqP is the input for backwards compatibility
0 none output
dPqPbase Unscaled normalized pressure drop (delta P/P), usually from socket S_dP.
0 none output[*]
s_dPqP Scalar on normalized pressure drop (delta P/P) 1 none input
s_dPqPaud scalar on audit normalized pressure drop 1 none inactive
* If the Socket is empty, the IO Status is input (see Sockets)
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
Fl_dP FlowStation Flow station for pressure loss calculation
Fl_I FluidInputPort Inlet fluid port
Fl_O FluidOutputPort Outlet fluid port
Sockets
Socket Description socketType Sets Values
S_dP Pressure loss socket that passes dPqPbase from duct subelement to parent duct ADIAB_DPNORM dPqPbase
Usage Notes
Duct - The duct element calculates an adiabatic pressure drop. - The pressure drop can either be input or calculated from a subelement. - The static conditions used for the pressure drop can come from either the inlet port or can be set directly in the internal station used to calculate the pressure loss. Which value used is controlled by the option switch, switchAdP. - The exit area can be set three ways. It can be set equal to the inlet port. It can be set equal to the internal station used to calculate the pressure drop. Or, it can be directly input to the port by the user. The method used is determined by the option switch, switchAout. - dPqP = normalized pressure loss = dP/P. - When switchAud is set to AUDIT: dPqP = dPqPbase * s_dPqPaud + a_dPqPaud.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-50
When switchAud is set to BASE: dPqP = dPqPbase.
Duct has a baseType of Element.
Background Date Author Description -------- --------------------- ------------------------------------- 07/18/06 R. Ashleman Created as result of ARP5571 Duct has a baseType of Element.
The DuctNASA element performs a simple adiabatic pressureloss calculation. The pressure loss is calculated by the S_dP socket (or input by the user if this socket is empty). The duct maintains a constant enthalpy while the pressure loss is applied.
Variables
Variable Description Default Units IO Status
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-51
Q Heat flow into the fluid 0 Btu/sec input
Q_dmd Subelement calculated Q 0 Btu/sec output[*]
Q_in Input Q 0 Btu/sec input
dP Actual pressure drop 0 psia output
dPqP Normalized pressure drop (delta P/P) 0 none output
* If the Socket is empty, the IO Status is input (see Sockets)
Option Variables
Variable Description Variables IOStatus Affected
Default Allowed Values
switchDP CALCULATE - Supplier-provided calculation (default) in socket S_dP which sets dPqP_dmd OFF - no pressure loss INPUT - Pressure loss, dPqP_in is input CUSTOM - Customer hook function in socket S_customDP which sets dPqP_dmd
None CALCULATE CALCULATE, OFF, INPUT, CUSTOM
switchQ OFF - No heat load (default) INPUT - Heat load is input CALCULATE - Supplier provided calculation in socket S_Q which sets Q_dmd CUSTOM - Customer hook function in socket S_customQ which sets Q_dmd
None OFF OFF, INPUT, CALCULATE, CUSTOM
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
Fl_dP FlowStation Flow station for pressure loss calculation
Fl_I FluidInputPort Inlet fluid port
Fl_O FluidOutputPort Outlet fluid port
Sockets
Socket Description socketType Sets Values
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-52
S_Q Thermal load socket Q_dmd
S_customDP Pressure loss socket (customer) dPqP_dmd
S_customQ Thermal load socket (customer) Q_dmd
S_dP Pressure loss socket dPqP_dmd
Usage Notes
DuctNASA - The duct element calculates an pressure drop. - The pressure drop can either be input or calculated from a subelement. - The heat loss can either be input or calculated from a subelement. - There are two option switches that determine where the dP and Q are calculated.
Background Date Author Description -------- --------------------- ------------------------------------- 07/18/06 R. Ashleman Created as result of ARP5571 DuctNASA has a baseType of Element.
[ Back to Index ]
2.16 Element
Variables
Variable Description Default Units IO Status
autoAddToSolvSeq 1 unset
Background Date Author Description -------- --------------------- ------------------------------------- 07/18/06 R. Ashleman Created as result of ARP5571 Element has a baseType of ElementBase.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-53
[ Back to Index ]
2.17 ElementBase
Variables
Variable Description Default Units IO Status
version particular version of each component input
Functions
Prototype Description
void clearSolverTerms () Sets the autoSetup flag to FALSE for all objects in the Solver. Objects aren't removed until autoSolverSetup is called.
void execute () Runs a sequence of commands specified by user to execute current Element/Subelement
string getExecutive () get the current executive
int getPassType () Identifies the current Model pass as the first pass of a convergence attempt (0), a matrix generation (perturbation) pass (1) or an iteration pass (2)
string[] listSocketTypes () function deprecated
void prePass () None
void run () Orders Solver to solve Model for a single point with the current input conditions
void setExecutive (string) set the current executive
void setupExecutive (int) set up the current executive
int varNameIsActiveIndep (string)
Determines if the given full variable pathname corresponds to the model variable controlled by any independents in the Solver
int verify () Returns 1 (TRUE) if the Model is valid, 0 (FALSE) if it is not
ElementBase has a baseType of VariableContainer.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-54
[ Back to Index ]
2.18 Emissions The Emissions element calculates emissions based on tables input by the user.
Variables
Variable Description Default Units IO Status
EICO Carbon Monoxide Emissions Index, grams per kilogram of fuel. 0 none output
EICO2 Carbon Dioxide Emissions Index, grams per kilogram of fuel. 0 none output by default input when switchCO2=INPUT
EIH2O Water Emissions Index 0 none input
EIHC Hydrocarbon Emissions Index, grams per kilogram of fuel. 0 none output
EINOx Nitrogen Oxide Emissions Index, grams per kilogram of fuel. 0 none output
EISOx Sulfur Oxide Emissions Index, grams per kilogram of fuel. 0 none input
Pt3 Total pressure at burner entrance 0 psia output
Pt3sls Total pressure determined from a table read using Tt3 0 psia input
Tt3 Total temperature at burner entrance 0 R input
Tt4 Total temperature at burner exit 0 R input
WAR Specific humidity 0 none input
expNOx Exponent for use in NOx calculation 0.5 none input
switchCO2 Determines if EICO2 is calculated or input EICO2 CALCULATE CALCULATE, INPUT
switchNOx Determine which NOx correlation to use None BOEING BOEING, NASA
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
Usage Notes
Emissions - This element is not a flow element and is not connected to any other elements. To use this element the user must map in the values of Tt3, Pt3, Tt4 from the other elements (probably Burner and FlightConditions1) by using a preexecute function. - The calculations for EICO, EIHC, EICO2 and the Boeing EINOx, are based on tabular data determined from a sea level test. The sea level data is then adjusted for the current flight condition. The methodology
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-55
used is documented in the paper: Salari, V.J., D.C. Eiler, R.L. Marshall, 'Effects of Operating Variables on Gaseous Emissions, Air Pollution Control Association (APCA) Specialty Conference on Air Pollution Measurement Accuracy as it Relates to Regulation Compliance,' New Orleans, October 26-28, 1975. - The EINOx methodology can be overridden by a NASA calculation. This calculation comes from the NEPP cycle program and was derived from tests done at NASA GRC on proprietary advanced concepts. - EICO2 is calculated from an equation based on the calculated values of EICO and EIHC. If the user wishes, this equation can be replaced with an input value. - The values for EISOx and EIH2O are always input. - To run correctly this subelement needs 3 tables when using the NASA method and 4 tables if using the Boeing method. For both methods the following tables are required: TB_Pt3sls, TB_EIHC, and TB_EICO. The Boeing method also requires TB_EINOx. All four tables are functions of the total temperature at the burner entrance, Tt3.
dTs Delta temperature from standard atmosphere 0 R output
Functions
Prototype Description
void calculate () None
int verify () None
Usage Notes
EngPerf - This element calculates uninstalled engine performance. - All that needs to be done to get this element to work is to include it in a model. (It should be the last element in the solver sequence.) It will automatically search the engine for the appropriate data. - The element requires that the model user elements of the type FlightConditions, Inlet, Compressor, Burner, Nozzle. If the model is using elements of different type for these calculations then this element needs to be modified.
The FlightConditions element will start a flow at an input altitude and Mach number. The altitude is used to determine the static temperature and pressure from curve fits based on the U.S. Standard Atmosphere 1976. The static conditions are then changed into total conditions using the input Mach number. The user can also input an ambient water-to-air ratio and a temperature offset.
Variables
Variable Description Default Units IO Status
MN Input Mach number 0 none input
Ps Ambient pressure 0 psia output
Ts Ambient temperature 0 F output
W Airflow 0 lbm/sec input
WAR Water-to-air ratio 0 none output
alt Input altitude 0 ft input
dTs Delta temperature from standard atmosphere 0 R input
The FlowDuplicator element takes a flow coming into the duplicator and replicates it into two ports coming out of the duplicator. This can be used to run a model with parallel flow streams without having to recreate the model. An example of this would be running an engine with three different nozzles. NOTE: This element will result in mass creation. It should be used very carefully by experienced users.
The FlowEnd element terminates a flow stream. It has one input port.
Variables
Variable Description Default Units IO Status
Pt Total pressure at exit 0 psia input
Tt Total temperature at exit 0 R input
W Fluid flow at exit 0 lbm/sec input
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
Fl_I FluidInputPort Primary inlet flow
Usage Notes
FlowEnd
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-61
No Provisional Errors or Warnings - If the user wishes to terminate multiple flows at the same location, then he must combine those streams into an element upstream of the FlowEnd.
FlowStart will start a flow stream with user inputs of weight flow, total temperature, and total pressure. Vitiated air may also be specified by supplying a fuel-to-air ratio and inputs (similar to those found in the FuelStart) to specify the fuel.
Variables
Variable Description Default Units IO Status
Carbon Carbon mass fraction 1 none input
FAR Fuel-to-air ratio of the exiting flow 0 none input
Hydrogen Hydrogen mass fraction 0.16 none input
LHV Lower heating value 18400 Btu/lbm input
Nitrogen2 Nitrogen mass fraction 0 none input
Oxygen Oxygen mass fraction 0 none input
Pfuel Fuel storage pressure 0 psia input
Pt Total pressure of the flow 0 psia input
Tfuel Fuel storage temperature 530 R input
Tref Reference temperature 0 R input
Tt Total temperature of the flow 0 R input
W Weight flow 0 lbm/sec input
WAR Water-to-air ratio 0 none input
fuelType Type of fuel none input
hFuel Enthalpy of the fuel at storage conditions 0 Btu/lbm input
hRef Enthalpy of the fuel at reference conditions 0 Btu/lbm input
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-62
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
fuel FuelStation Temporary station used to calculate vitiated flow conditions
Fl_O FluidOutputPort Primary exit flow
Usage Notes
FlowStart No Provisional Errors or Warnings - FlowStart is similar to FlightConditions1 except the user defines the total pressure and temperature rather than have them calculated from atmospheric tables and Mach number. - This element is used when the user knows the flow conditions at a given point (a rig test for example). - Fuel conditions are specified when user wanted to specify the flow conditions upstream of a turbine element for example.
Wfrac1 Fraction of fuel flow that goes to Fu_O1. The rest of the fuel will go to Fu_O2 0 none input
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-63
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
Fu_I FuelInputPort Fuel input port
Fu_O1 FuelOutputPort Fuel exit port
Fu_O2 FuelOutputPort Fuel exit port
Usage Notes
FuelSplitter - This element will take a fuel stream and split into two flows based on the input value of Wfrac. Wfrac1 * Win will go into Fu_O1. Wfrac1 * ( 1 - Win ) will go into Fu_O2.
A fuel stream is defined and initiated. A FuelStart component is required to define the fuel properties for a burner.
Variables
Variable Description Default Units IO Status Carbon Carbon mass fraction 1 none input Hydrogen Hydrogen mass fraction 0.16 none input
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-64
LHV Lower heating value 18400 Btu/lbm input LHV_in Input value of LHV. If not zero then it overwrites LHV. Used
for ARP compliance 0 Btu/lbm input
Nitrogen2 Nitrogen mass fraction 0 none input Oxygen Oxygen mass fraction 0 none input Pfuel Storage pressure 14.696 psia input Tfuel Fuel storage temperature 0 R input Tref Fuel reference temperature 0 R input Wfuel Fuel flow 0 lbm/sec input dCpqdT Rate of change of Cp with respect to temperature 0 Btu/(lbm*R*R) input fuelType Fuel type for description of CEA fuel none input hFuel Enthalpy of the fuel at storage conditions 0 Btu/lbm output[*] hRef Enthalpy of the fuel at reference conditions 0 Btu/lbm input * If the Socket is empty, the IO Status is input (see Sockets)
Functions
Prototype Description void calculate () None
Ports and Internal Stations
Port/Station Type Description Fu_O FuelOutputPort Fuel exit port
Sockets
Socket Description socketType Sets Values S_hFuel Calculates the fuel enthalpy from the input P and T HFUEL hFuel
Usage Notes
FuelStart * This element starts a fuel flow, allowing the user to specify the fuel enthalpy, constituents, and fuel heating value. * The inputs of Carbon, Hydrogen, and Nitrogen2 allow the user to specify the chemical make-up of the fuel by weight fractions (note the fractions are taken relative to each other and the total does not have to be 1). The input of oxygen allows the user to specify the amount of oxygen that the fuel consumes. * The different thermodynamic packages will do different things with the composition depending on their fidelity of analysis. * The enthalpy of the fuel is described by inputing four values. The enthalpy and temperature of the fuel at the
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-65
reference conditions and the enthalpy and temperature of the fuel at the storgae conditions. A socket is available to use a subelement to calculate fuel enthalpy from temperature. The reference enthalpy and actual enthalpy are used in conjuction with LHV to determine the burn conditions. * Note that when using CEA, LHV and reference enthalpy have no effect. In this case, the only pertinent value is the actual fuel enthalpy.
HeatExchanger models thermal energy transfer between two parallel streams using either an effectiveness or heat flow. Pressure losses may be applied to each stream.
Variables
Variable Description Default Units IO Status
Q Heat flow from one side to another (positive when energy flows from stream 1 to stream 2
0 Btu/sec output[*]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-66
Q_dmd Demand vale of Q from customer socket 0 Btu/sec output[*]
Q_in Input value of Q 0 Btu/sec output
cap1 Capacity of flow stream 1 (W*Cp) 0 Btu/(sec*R) output
cap2 Capacity of flow stream 2 (W*Cp) 0 Btu/(sec*R) output
capMin Minimum of the two streams capacities 0 Btu/(sec*R) output
dPqP1 Pressure loss in stream 1 0 none input
dPqP2 Pressure loss in stream2 0 none input
dPqPbase Normalized pressure loss (used to temporarily store values returned from the pressure loss sockets)
0 none output[*]
effect Heat transfer effectiveness 0 none output[*]
* If the Socket is empty, the IO Status is input (see Sockets)
switchQ Determines if the heat transfer rate is input or calculated from an effectiveness
None INPUT INPUT, OFF, CALCULATE, CUSTOM
switchQcalc Determines if the heat transfer rate is input or calculated from an effectiveness
effect, Q EFFECT EFFECT, Q
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
Fl_dP FlowStation Temporary FlowStation used to pass data to the pressure loss Subelements. Used because the dPnorm subelements expect to reference the incoming conditions in Fl_I.
Fl_I1 FluidInputPort Fluid input port 1
Fl_I2 FluidInputPort Fluid input port 2
Fl_O1 FluidOutputPort Fluid output port 1
Fl_O2 FluidOutputPort Fluid output port 2
Sockets
Socket Description socketType Sets Values
S_Q Heat flow or effectiveness from stream 1 to stream 2 HX_QE Q, effect, switchQcalc
S_customQ Customer socket for Q value Q_dmd, effect, switchQcalc
S_dPqP1 Stream 1 pressure loss calculation ADIAB_DPNORM dPqPbase
S_dPqP2 Stream 2 pressure loss calculation ADIAB_DPNORM dPqPbase
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-67
Usage Notes
HeatExchanger - Energy exchanged between the two streams is defined by either effectiveness (effect) or total heat flow (Q) as determined by switchQcalc. These values may be directly input or determined by a subelement plugged into the S_Q socket. - Stream pressure drops may be input through sockets, S_dPqP1 and S_dPqP2 or if sockets are empty directly through dPqP1 and dPqP2. - Heat exchanger may be turned off by setting either effect or Q to zero. - Steady-state operating conditions only. Transient thermal transfer and storage in structure is not modeled. - The calculations are based on 'Compact Heat Exchangers. Third Edition' by W. M. Kays and A. L. London, The National Press, 1984.
The Inlet will calculate the performance of a standard inlet. A pressure drop based on ram recovery may be applied. The ram recovery value can either be input or supplied from a subelement.
Variables
Variable Description Default Units IO Status
Afs Freestream area 0 in2 output Fram Ram drag 0 lbf output MN Actual free stream Mach number passed to ramRecovery subelement 0 none output PqP_in Input recovery. If not zero it will overwrite eRam (for ARP) 0 none output a_eRamAud Ram pressure recovery adder 0 none input eRam Ram pressure recovery 1 none output eRamBase Unscaled ram pressure recovery 1 none output[*] s_eRamAud Ram pressure recovery scalar 1 none input * If the Socket is empty, the IO Status is input (see Sockets)
Inlet No Provisional Errors or Warnings - The inlet has single inlet and output flow ports. - Note that the inlet does not start a flow. An element must be upstream of the inlet to provide flow (FlightConditions1 or FlowStart for example). - The freestream area is not defined at zero speed; it goes to infinity.
Inlet has a baseType of Element.
[ Back to Index ]
2.29 InletStartNASA INLETSTART ELEMENT -------------------- | | | | | INLETSTART |---> Fl_O | | | | -------------------- InletStartNASA will define the starting conditions for flow into a downstream inlet.
Variables
Variable Description Default Units IO Status
AmbientName Name of Ambient component for obtaining reference variables (string)
none input
MNname Name of variable location where MN is referenced (string)
none input
Pt1name Name of variable location where Pt1 is referenced (string)
none input
Tt1name Name of variable location where Tt1 is referenced (string)
none input
W Inlet airflow 0 lbm/sec output
WARname Name of variable location where WAR is referenced (string)
none input
W_in Inlet airflow at design 0 lbm/sec input
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-70
Wc Inlet corrected airflow 0 lbm/sec output by default input when switchDes=OFFDESIGN
switchInd select independent variable: WC or W None WC WC, W
Functions
Prototype Description
void VCinit () None
void calculate () None
real getW_in () None
real getWc_in () None
void setW_in (real val) None
void setWc_in (real val) None
void variableChanged (string name, any oldVal) None
int verify () None
Ports and Internal Stations
Port/Station Type Description
Fl_O FluidOutputPort Exit flow
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-71
Independents
Name Description Default Active When
ind_W Inlet air flow W Manual
ind_Wc Inlet corrected air flow Wc switchDes=OFFDESIGN
Usage Notes
The inlet start element will set inlet start conditions based on flight conditions parameters which are obtained from Ambient element. InletStart will also handle balance on the inlet corrected or actual flow which should be passed to the inlet (inlet should be configured following InletStart). AmbientName input string defines name of reference Ambient component where ref T, P, WAR are obtained. These value may be individually overwritten by optional inputs of MNname, Pt1name, Tt1name, or WARname. Blank input defaults to first Ambient component.
Instrument allows the user to read data from the simulation and compare it to experimental values. Used to support data reduction capabilities.
Variables
Variable Description Default Units IO Status
a_measAdj Adder applied to cycle calculated value (done after instrumentation effects have been applied)
0 none input
base Base value (usually read cycle code) -999 none output
baseName Name of the base value USERSET input
errMeasAdj Error between cycle calculate value and test value 0 none output
indName Name of the value that is varied in the solver to match the cycle. input
indRef Reference that is used to scale the independent in the solver input
indValue 0 unset
meas Measured value (usually read from test data or database) -999 none output[*]
measAdj Cycle calculated value adjusted for instrumentation measurement effects 0 none output[*]
measMax Maximum acceptable measured value (used to check valid status) 1.79769e+308 none input
measMin Minimum acceptable measured value (used to check valid status) 2.22507e-308 none output
measName Name of the measured value USERSET input
missing Number that corresponds to missing data -999 none output
s_measAdj Scalar applied to cycle calculated value (done after instrumentation effects have been applied)
1 none input
tol Acceptable difference between measured and predicted value (used to check valid status)
0.1 none input
valid Flag 0 none output
* If the Socket is empty, the IO Status is input (see Sockets)
Option Variables
Variable Description Variables IOStatus Affected
Default Allowed Values
DRMode Determines what data reduction mode the instrument is in
None Predicted Predicted, AsMeasured, Corrected
switchDes Design mode switch
None DESIGN DESIGN, OFFDESIGN
switchError Determines if the error is a delta or a ratio
None RATIO RATIO, DELTA
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-73
switchSolverActive Determines when the default independent is added to the solver. AsMeasured only adds them in the AsMeasured mode. Predicted will add them in the Predicted and AsMeasured mode.
None AsMeasured AsMeasured, Predicted, Always, Never
switchValid Determines how the experimental data is compared to the model data
void variableChanged (string name, any oldVal) None
Sockets
Socket Description socketType Sets Values
S_Cal Adjusts the actual measured value to adjust the actual sensor reading INSTRUMENT_MEASCALC meas
S_Dyn Adjusts the measured value for dynamic lag effects INSTRUMENT_MEASADJ measAdj
S_GPC Adjusts the measured value for differences between the gas path and sensor values
INSTRUMENT_MEASADJ measAdj
S_Rec Adjusts the measured value for total/static effects INSTRUMENT_MEASADJ measAdj
S_Usr Adjusts the measured value for user supplied effects INSTRUMENT_MEASADJ measAdj
S_WC Adjusts the measured value for wire loss effects INSTRUMENT_MEASADJ measAdj
Independents
Name Description Default Active When
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-74
ind_vary Varies a model parameter meas switchSolverActive=Predicted, Always
Dependents
Name Description eq_lhs eq_rhs Active When
dep_match Forces the base and measAdj values to be the same measAdj base switchSolverActive=Predicted, Always
Usage Notes
Instrument - The Instrument element performs three functions. First, it will determine if the data is valid by comparing the test data to the predicted cycle data. Second, it will use the autoSolver to add the appropriate independents and dependents to the solver setup. Third, it will correct the measured value for instrumentation effects using different subelements. - The Instrument element works by comparing a base value to a measured value. The base value can either be put in directly, or the user can reference it by name. Also, the measured value can either be put in directly of the user can reference it by name. - The method that the Instrument uses for the validity check is controlled through the switchValid option. Also sorts of combinations are available that will check for data missing and data being within an absolute or relative tolerance. - The Instrument element also will automatically add the a solver independent and dependent to the solver set up that will vary a cycle parameter to match base with meas. To use this capability, the user must identify the independent variable by name. - When the independent and dependent are added to the solver is controlled by the switchSolverActive switch.
switchRakes Determines if the rakes are in the flow or not [ OUT / IN ]
None OUT OUT, IN
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
Fl_dP FlowStation Flow station for pressure loss calculation
Fl_I FluidInputPort Input Fluid Port
Fl_O FluidOutputPort Exit Fluid Port
Sockets
Socket Description socketType Sets Values
S_dP Pressure loss calculated by subelement ADIAB_DPNORM dPqPbase
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-76
Usage Notes
InstrumentDuct - The instrument duct element calculates an adiabatic pressure drop. The difference between the instrument duct and the regular duct is the ability to turn the pressure loss off by a switch. This is done to allow the user to quickly simulate a rakes versus rakes out condition. - The pressure drop can either be input or calculated from a subelement. - The static conditions used for the pressure drop can come from either the inlet port or can be set directly in the internal station used to calculate the pressure loss. Which value used is controlled by an option switch. - The exit area can be set three ways. It can be set equal to the inlet port. It can be set equal to the internal station used to calculate the pressure drop. Or, it can be directly input to the port by the user. The method used is determined by an option switch.
Fl_dP FlowStation Temporary station to store flow information for dPqP
Fl_I1 FluidInputPort Fluid input port 1
Fl_I2 FluidInputPort Fluid input port 2
Fl_O1 FluidOutputPort Fluid output port 1
Fl_O2 FluidOutputPort Fluid output port 2
Sockets
Socket Description socketType Sets Values
S_dP1 Pressure loss socket that passes dPqPbase from the subelement to the output port 1 for normal operation.
ADIAB_DPNORM dPqPbase
S_dP1i Pressure loss socket that passes dPqPbase from the subelement to the output port 1 for inverted operation.
ADIAB_DPNORM dPqPbase
S_dP2 Pressure loss socket that passes dPqPbase from the subelement to the output port 2 for normal operation.
ADIAB_DPNORM dPqPbase
S_dP2i Pressure loss socket that passes dPqPbase from the subelement to the output port 2 for inverted operation.
ADIAB_DPNORM dPqPbase
Usage Notes
InverterValve No provisional errors or warnings. - This is a steady state Inverter Valve Element which allows the swapping of two fluid streams. It performs an adiabatic pressure loss on the streams which is determined by optional subelements and the switch position which controls normal vs. inverted flow. The Valve has two input ports and two output ports. Pressure loss calculations are done
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-79
based on output port not on stream. (i.e., 'S_dP1' & 'S_dP1i' always calculate loss on stream leaving through FluidOutputPort 'A' regardless of switch position.) - Running a design point with the switchInv set to either NORMAL or INVERTED will cause only the two subelements S_dP1 and S_dP2, or S_dP1i and S_dP2i respectively to be called. A multipoint design or user input of the scalars/adders will be necessary for proper off-design operation of the subelements not called during the design point.
The Loadelement imposes a torque load on a shaft. The torque is either directly input or is from a table function of two user-input parameters.
Variables
Variable Description Default Units IO Status
NR Ratio of load to shaft speed 1 none input
Nload Load speed 0 rpm output
inertia Inertia of load component 0 slug*ft2 input
parmLoad_x X input to load torque table 0 none input
parmLoad_y Y input to load torque table 0 none input
pwr Horsepower from load 0 hp output
trq Torque to shaft 0 ft*lbf output
trqLoad Torque from load 0 ft*lbf input
Functions
Prototype Description
void calculate () None
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-80
Ports and Internal Stations
Port/Station Type Description
Sh_O ShaftOutputPort Shaft output port
Usage Notes
Load - In addition to turbines and compressors, a variety of torque loads are imposed on a shaft. These loads include accessories such as starters, generators, or customer power takeoffs connected to a shaft, bearing losses, or loads intentionally applied to a shaft for testing purposes, e.g., by a water brake. - Loads are typically modeled empirically by a torque load as a function of a load speed and/or some arbitrary number of user-input parameters. For example, a water brake may provide a torque load as a function of brake inlet pressure and temperature, as well as brake speed. - There is one outlet port that connects to a shaft. - Load is defined by an input of torque, trqLoad, or a table, TB_Load = f(parmLoad_y, parmLoad_x). - Nload = Sh_O.Nmech * NR; - pwr = trqLoad * Nload * 2*PI/60/550; - trq = trqLoad * NR;
switchDesStream Determines which stream will be used to design the input conditions. If set to 1, then the static pressure from stream 1 will be used to size the entrance conditions. If set to 2, then the static pressure from stream 2 will be used to size the entrance conditions.
None 1 1, 2
switchSubCalc If OUTSIDE, then will run faster but subelements cannot be a function of Fl_O
None OUTSIDE OUTSIDE, INSIDE
Functions
Prototype Description
void calculate () None
void subCalculate () None
void variableChanged (string name, any oldVal) None
iterMN SecantSolver solver for exit total pressure
iterPt SecantSolver solver for exit total pressure
Usage Notes
Mixer No Provisional Errors or Warnings. The mixer conserves energy, continuity, and momentum when mixing two streams into one. At design point the user needs to provide a Mach number for the primary entrance flow. This Mach number determines the primary entrance area. The secondary entrance area is determined by varying the Mach number until the static pressure of the two streams is equal. The exit area is determined by adding the two entrance areas together (constant area mixer). In off design mode it is prefer to set AphyDes=0.0 and hold the constant area mixing rule. The option still exists for an AphyDes different from Aphy1 + Aphy2 but an a_Impulse should be supplied to account for the force acting of the difference from summed input areas and exit area. The mixer has a socket for calculating a partial mixing thrust correction. This value can be fed into a nozzle and used in the thrust calculations. The mixer also has a socket for calculating an adder that is applied to the incoming impulse terms (both pressure force and momentum). This number can be used to account for losses occurring inside the mixer. Finally, the mixer has sockets for calculating coefficients which are applied to incoming momentum or impulse terms. These terms can also be used to account for losses inside the mixer.
switchFrozen Determines if the ideal and actual exit conditions are calculated based on equilibrium or frozen (throat) conditions
None FROZEN FROZEN, EQUIL
switchType Switch to specify type of nozzle geometry. None CON_DIV CON_DIV, CONIC, FIXED
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-86
Functions
Prototype Description
void VCinit () None
void calculate () None
void variableChanged (string name, any oldVal) None
int verify () None
Ports and Internal Stations
Port/Station Type Description
Fl_Oideal FlowStation Ideal exit flow conditions
Fl_Th FlowStation Throat flow conditions
Fl_I FluidInputPort Incoming flow
Fl_O FluidOutputPort Outgoing flow
Sockets
Socket Description socketType Sets Values
S_Cang Returns the nozzle thrust correction due to flow angle variation at the exit. CANGULAR Cang
S_CdTh Returns the discharge coefficient at the throat CDTH CdTh
S_Cfg Returns the gross thrust coefficient CFGR Cfg
S_Cqua Returns the throat area change due to thermal expansion CQUA Cqua
S_Cv Returns the nozzle thrust correction due to velocity variations at the exit CVELOCITY Cv
S_dP Returns the normalized pressure drop from nozzle inlet to throat. ADIAB_DPNORM dPqP
Dependents
Name Description eq_lhs eq_rhs Active When
dep_Area Error to balance out the flow mismatch WqAE WqAEdem switchDes=OFFDESIGN
Other Objects
Name Type Description
iterMN SecantSolver solver for MN
Usage Notes
Nozzle No Provisional Errors or Warnings. - Nozzle calculations require the user to specify the exhaust static pressure. This is best done by providing the complete path name of a variable holding the nozzle exhaust static pressure in string variable PsExhName (for example, PsExhName = 'Amb.Pamb' for a model with a FlightConditions1 element named Amb). If this string is not set, then variable PsExh must be set by the user, most likely with a preexecute()function. - The nozzle mixing coefficient, CmixCorr, is often calculated in another element (for example, partialMix calculated in the Mixer1 element by
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-87
subelement partialMixingThrustCorrection). The user can specify the complete path name of a variable holding the thrust correction coefficient in string variable CmixName (for example, CmixName = 'Mix.partialMix' for a model with a Mixer1 element named Mix). Alternatively, the user can supply the desired value directly using variable CmixCorr. If there is no partial mixing correction, leave both CmixName and CmixCorr unchanged. The default value CmixCorr = 1 will then be used. CmixCorr is used only when switchCoef = CV. - Nozzle has three modes for exit area, controlled by switchType. When switchType = CONIC, a convergent nozzle calculation is performed in which the throat is the nozzle exit. A fixed area (specified by AthCold, and modified by Cqua and CdTh) is used if switchDes = OFFDESIGN. If switchDes = DESIGN, the exit area is calculated to match the specified exhaust static pressure, or give an exit Mach number of 1 if the nozzle pressure ratio is sufficient to choke the nozzle. When switchType = CON_DIV, a convergent-divergent nozzle calculation is performed in which an exit area is calculated that perfectly expands the flow to the specified exhaust pressure. When switchType = FIXED, a convergent-divergent nozzle calculation is performed in which the exit area is fixed by AthCold, Cqua, and CdTh. - The nozzle has two modes for calculating losses controlled by switchCoef, CV and CFG. When switchCoef = CV, Fg = FgIdeal * Cang * Cv * CmixCorr, with Cfg being ignored. When switchCoef = CFG, Fg = FgIdeal * Cfg with Cang, Cv, and CmixCorr being ignored. - NPSS flowstations can calculate flow properties based on either equilibrium or frozen chemistry (see the Thermodynamic Reference Sheets). Ordinarily, the default setting is for equilibrium flow. The Nozzle element, however, sets the nozzle exit and ideal exit to frozen chemistry. This effectively freezes the flow at the nozzle throat. If this is not desired, the user should override this setting in the Fl_O and Fl_Oideal flow stations as described in the Thermodynamic Reference Sheets. Of course, the user can also freeze the flow earlier, if desired, by overriding the equilibrium chemistry default for flow stations at and upstream of the nozzle throat. - The amount of flow the nozzle can pass is determined by the throat area. In DESIGN mode this area is calculated. If the overall pressure ratio is greater than 1.0, then the nozzle is choked in design mode. In this case the area is determined by setting the Mach number equal to 1.0 and calculating the area. If the nozzle is not choked, then the area is determined by setting the static pressure equal to the exit static pressure and determining the area. In OFF-DESIGN mode the nozzle throat area is determined from the design area and a thermal expansion coefficient that calculates the effect of temperature on the throat area. In addition, the flow station will determine the area actually required to pass the flow. A default dependent is created and can be accessed through the auto-solver setup that will balance the actual area with the demand area.
switchFrozen Determines if the ideal and actual exit conditions are calculated based on equilibrium or frozen (throat) conditions
None FROZEN FROZEN, EQUIL
switchType Switch to specify type of nozzle geometry. None CON_DIV CON_DIV, CONIC, FIXED
Functions
Prototype Description
void VCinit () None
void calculate () None
void variableChanged (string name, any oldVal) None
int verify () None
Ports and Internal Stations
Port/Station Type Description
Fl_Oideal FlowStation Ideal exit flow conditions
Fl_Th FlowStation Throat flow conditions
Fl_I FluidInputPort Incoming flow
Fl_O FluidOutputPort Outgoing flow
Sockets
Socket Description socketType Sets Values
S_Cang Returns the nozzle thrust correction due to flow angle variation at the exit. Cang
S_CdTh Returns the discharge coefficient at the throat CdTh
S_Cfg Returns the gross thrust coefficient Cfg
S_Cqua Returns the throat area change due to thermal expansion CQUA Cqua
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-91
S_Cv Returns the nozzle thrust correction due to velocity variations at the exit Cv
S_customCdTh Socket for customer CdTh CdTh_dmd
S_customCfg Socket for customer Cfg Cfg_dmd
S_customCv Socket for customer Cv Cv_dmd
S_dP Returns the normalized pressure drop from nozzle inlet to throat. dPqP
Dependents
Name Description eq_lhs eq_rhs Active When
dep_Area Error to balance out the flow mismatch WqAE WqAEdem switchDes=OFFDESIGN
Other Objects
Name Type Description
iterMN SecantSolver solver for MN
Usage Notes
NozzleNASA No Provisional Errors or Warnings. - Nozzle calculations require the user to specify the exhaust static pressure. This is best done by providing the complete path name of a variable holding the nozzle exhaust static pressure in string variable PsExhName (for example, PsExhName = 'Amb.Pamb' for a model with a FlightConditions1 or Ambient element named Amb). If this string is not set, then variable PsExh must be set by the user, most likely with a preexecute() function. - The nozzle mixing coefficient, CmixCorr, is often calculated in another element (for example, partialMix calculated in the Mixer1 element by subelement partialMixingThrustCorrection). The user can specify the complete path name of a variable holding the thrust correction coefficient in string variable CmixName (for example, CmixName = 'Mix.partialMix' for a model with a Mixer1 element named Mix). Alternatively, the user can supply the desired value directly using variable CmixCorr. If there is no partial mixing correction, leave both CmixName and CmixCorr unchanged. The default value CmixCorr = 1 will then be used. CmixCorr is used only when switchCoef = CV. - Nozzle has three modes for exit area, controlled by switchType. When switchType = CONIC, a convergent nozzle calculation is performed in which the throat is the nozzle exit. A fixed area (specified by AthCold, and modified by Cqua and CdTh) is used if switchDes = OFFDESIGN. If switchDes = DESIGN, the exit area is calculated to match the specified exhaust static pressure, or give an exit Mach number of 1 if the nozzle pressure ratio is sufficient to choke the nozzle. When switchType = CON_DIV, a convergent-divergent nozzle calculation is performed in which an exit area is calculated that perfectly expands the flow to the specified exhaust pressure. When switchType = FIXED, a convergent-divergent nozzle calculation is performed in which the exit area is fixed by AthCold, Cqua, and CdTh.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-92
- The nozzle has two modes for calculating losses controlled by switchCoef, CV and CFG. When switchCoef = CV, Fg = FgIdeal * Cang * Cv * CmixCorr, with Cfg being ignored. When switchCoef = CFG, Fg = FgIdeal * Cfg with Cang, Cv, and CmixCorr being ignored. - The source of values for Cv and Cfg are controlled by switchCv and switchCfg, respectively. Both switches have options CALCULATE, INPUT, and CUSTOM. The option CALCULATE for switchCv selects a supplier function for Cv through socket S_Cv. The CUSTOM option selects a customer hook function from socket S_customCv. Both sockets return a value of Cv_dmd which is set to Cv. The INPUT option sets Cv to the input value Cv_in. Similarly, switchCfg returns a value of Cfg_dmd from sockets S_Cfg or S_customCfg which is set to Cfg. The switchCfg INPUT option sets Cfg from the input value of Cfg_in. - NPSS flowstations can calculate flow properties based on either equilibrium or frozen chemistry (see the Thermodynamic Reference Sheets). Ordinarily, the default setting is for equilibrium flow. The Nozzle element, however, sets the nozzle exit and ideal exit to frozen chemistry. This effectively freezes the flow at the nozzle throat. If this is not desired, the user should override this setting in the Fl_O and Fl_Oideal flow stations as described in the Thermodynamic Reference Sheets. Of course, the user can also freeze the flow earlier, if desired, by overriding the equilibrium chemistry default for flow stations at and upstream of the nozzle throat. - The amount of flow the nozzle can pass is determined by the throat area. In DESIGN mode this area is calculated. If the overall pressure ratio is greater than 1.0, then the nozzle is choked in design mode. In this case the area is determined by setting the Mach number equal to 1.0 and calculating the area. If the nozzle is not choked, then the area is determined by setting the static pressure equal to the exit static pressure and determining the area. In OFF-DESIGN mode the nozzle throat area is determined from the design area and a thermal expansion coefficient that calculates the effect of temperature on the throat area. In addition, the flow station will determine the area actually required to pass the flow. A default dependent is created and can be accessed through the auto-solver setup that will balance the actual area with the demand area.
SFC Specific fuel consumption 0 lbm/(hr*lbf) output
Wfuel Overall fuel flow (lbm per hr) 0 lbm/hr output
_ptrFg { } unset
_ptrFram { } unset
_ptrPs INTERNAL USE ONLY: reference for ambient pressure none unset
_ptrWfuel { } unset
Functions
Prototype Description
void calculate () None
int verify () None
Usage Notes
PerfNASA - This element calculates total engine performance parameters: total engine gross thrust (Fg), net thrust (Fn), corrected net thrust (Fnc), ram drag (Fram), installation drag (Fd) (excluding Fram), total fuel flow (Wfuel) used in SFC calculation, specific fuel consumption - power or thrust (SFC), and delivered shaft power (pwrSD). - All that needs to be done to get this element to work is to include it in a model. (It should be the last element in the solver sequence.) It will automatically search the engine for the appropriate data. - The element requires that the model use elements of the type Inlet, Compressor, Burner, Nozzle. If the model uses elements of different type for these calculations then this element needs to be modified.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-94
Background Date Author Description -------- --------------------- ------------------------------------- 07/17/06 R. Ashleman Update for ARP5571 03/16/05 R. Ashleman Modify for FlightConditions->AmbientNew PerfNASA has a baseType of Element.
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
Fl_I FluidInputPort Primary incoming flow stream
Fl_O FluidOutputPort Primary exiting flow stream
Sh_O ShaftOutputPort Mechanical connection to the shaft
Sockets
Socket Description socketType Sets Values
S_CT Socket returns CT value PROPCT CT
Usage Notes
Propeller No Provisional Errors or Warning. - This element computes the performance of propellers as engine components and is one form of a load component. At the element level the propeller is sized and the power coefficient, advanced ratio, and propeller thrust are calculated. The socket calculates the scaled thrust coefficient used in the thrust calculation.
The Shaft element provides basic mechanical connections between rotating elements such as turbines and compressors. The Shaft element is responsible for providing a power balance between all components connected to it.
Variables
Variable Description Default Units IO Status
HPX Horsepower extracted from the shaft 0 hp input
Nmech Mechanical speed of the shaft 0 rpm input
dNqdt Derivative of speed with respect to time - acceleration 0 rpm/sec output
fracLoss Fractional loss on the positive port torque (see Usage Notes) 0 none input
inertia Inertia of the shaft itself 0 slug*ft2 input
inertiaSum Total inertia of the shaft and attached components 0 slug*ft2 output
pwrIn Total of all positive horsepower at the shaft ports 0 hp output
pwrNet Total of all power on the shaft 0 hp output
pwrOut Total of all power coming off the shaft 0 hp output
shaftPortList { } unset
trqIn Total of all torques coming into the shaft 0 ft*lbf output
trqNet Net total of all torques on the shaft and losses (see Usage Notes) 0 ft*lbf output
trqOut Total of all negative torques at shaft ports 0 ft*lbf output
void variableChanged (string name, any oldVal) None
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-97
Ports and Internal Stations
Port/Station Type Description
Name at runtime ShaftInputPort set at runtime
Independents
Name Description Default Active When
ind_Nmech Default independent to vary mechanical speed Nmech switchDes=OFFDESIGN
Dependents
Name Description eq_lhs eq_rhs Active When
integrate_Nmech Default integrator to balance out the net torques trqNet 0.0000 switchDes=DESIGN, OFFDESIGN
Usage Notes
Shaft - The shaft element can have any number of mechanical ports attached to it. These ports are declared at run time when the element is created. - In steady-state mode the solver will vary the shaft mechanical speed to balance the input ports torque with the output ports torque. - In transient mode the mechanical speed is varied until the mechanical speed set by the solver is equal to the mechanical speed determined by integrating the acceleration determined from the net torque. - Note that the shaft has only input mechanical ports, they are connected to compressor, turbine, and load component output mechanical ports. - Each port is looked at and its torque summed in either trqPos or trqNeg depending on whether it is greater or less than 0. - trqNet = trqIn * ( 1 - fracLoss ) + trqOut - HPX / ( Nmech * 2*PI/60/550 ); - The power terms are next calculated from the torque terms: pwr = trq * Nmech * 2*PI/60/550; - If the inertiaSum is non-zero then an acceleration is calculated: dNqdt = ( trqNet / inertiaSum ) * 60/(2*PI)
shaftStatus Indicator of the shaft being connected or not None CONNECTED
CONNECTED, BROKEN
Functions
Prototype Description
void calculate () None
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-99
Ports and Internal Stations
Port/Station Type Description
Sh_O1 ShaftOutputPort Output to Shaft 1
Sh_O2 ShaftOutputPort Output to Shaft 2
Independents
Name Description Default Active When
ind_theta Independent that allows solver to vary shaft speed theta shaftStatus=CONNECTED, BROKEN
Dependents
Name Description eq_lhs eq_rhs Active When
integ_shaftTheta Integrator that forces the two shaft speeds equal in steady-state mode and forces the speed to be equal to the integral of the speed derivative in transient mode
N1 N2 shaftStatus=CONNECTED, BROKEN
Usage Notes
ShaftSpring - This element models devices and processes that link (connect or disconnect) two shafts. These include: gear boxes, torsional dynamics (both spring and damping effects), clutches and breakage. In each case, the means by which the individual shaft elements communicate is the angular deflection between the two shafts; this is a state variable that is also implemented as a solver independent variable. - It is assumed that the Shafts will not be executed until all the ShaftSprings have been executed. - This element connects two shaft elements by means of the torques transferred between them. In steady state, the two shaft elements connected together in some fashion must turn at the same rotational speed, except when the connection is through a gearbox. In the latter case, the two speeds are algebraically related. - The shaft dynamics are obtained transiently by transmitting the deflection and damping torques to the shafts. The torque required to deflect the shaft by a given angular amount is obtained from the shaft spring constant multiplied by the deflection angle. The deflection angle is calculated by integrating its derivative, that is, the difference between the two connected shaft element speeds. The state variable for this effect is the angular deflection of the shaft. - Mechanical damping of the shafts can also be modeled by calculating a torque increment that resists shaft acceleration and is a function of the shaft speed difference. The torques resulting from this calculation are applied to each shaft separately in the same manner as the deflection torque. - When the shaft is connected in a steady-state mode, the system will
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-100
determine the angular deflection from the amount of torque being transmitted through the shaft. - It is generally assumed that the turbine shaft is connected to port Sh_O1 and the compressor shafts are connected to port Sh_O2. This is important in that the gear ratio and gear efficiency are applied. The gear ratio convention is that a ratio greater than one means that Sh_O2 spins slower that Sh_O1. A gear efficiency of less than 1.0 means that Sh_O2 has less power than Sh_O1. - It is important to note that a spring constant should always be input. This is even true when the user wants to go from a rigid to broken shaft. In this case, the spring constant should be input with a large enough value that the shaft dynamics are not a factor in the engine transient. - Finally, this element should generally have a guess function supplied. (Zero torque is a bad value.) A good guess would be to guess the deflection angle as the torque supplied by the turbine divided by the spring constant.
shaftStatus Indicator of the shaft being connected or not
None CONNECTED CONNECTED, BROKEN
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
Sh_O1 ShaftOutputPort Output to Shaft 1
Sh_O2 ShaftOutputPort Output to Shaft 2
Independents
Name Description Default Active When
ind_theta Independent that allows solver to vary shaft speed theta shaftStatus=CONNECTED, BROKEN
Dependents
Name Description eq_lhs eq_rhs Active When
integ_shaftTheta Integrator that forces the two shaft speeds equal in steady-state mode and forces the speed to be equal to the integral of the speed derivative in transient mode
N1 N2 shaftStatus=CONNECTED, BROKEN
Usage Notes
ShaftSpringNASA - This element models devices and processes that link (connect or disconnect) two shafts. These include: gear boxes, torsional dynamics (both spring and damping effects), clutches and breakage. In each case, the means by which the individual shaft elements communicate is the angular deflection between the two shafts; this is a state variable that is also implemented as a solver independent variable. - It is assumed that the Shafts will not be executed until all the ShaftSprings have been executed. - This element connects two shaft elements by means of the torques
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-102
transferred between them. In steady state, the two shaft elements connected together in some fashion must turn at the same rotational speed, except when the connection is through a gearbox. In the latter case, the two speeds are algebraically related. - The shaft dynamics are obtained transiently by transmitting the deflection and damping torques to the shafts. The torque required to deflect the shaft by a given angular amount is obtained from the shaft spring constant multiplied by the deflection angle. The deflection angle is calculated by integrating its derivative, that is, the difference between the two connected shaft element speeds. The state variable for this effect is the angular deflection of the shaft. - Mechanical damping of the shafts can also be modeled by calculating a torque increment that resists shaft acceleration and is a function of the shaft speed difference. The torques resulting from this calculation are applied to each shaft separately in the same manner as the deflection torque. - When the shaft is connected in a steady-state mode, the system will determine the angular deflection from the amount of torque being transmitted through the shaft. - It is generally assumed that the turbine shaft is connected to port Sh_O1 and the compressor shafts are connected to port Sh_O2. This is important in that the gear ratio and gear efficiency are applied. The gear ratio convention is that a ratio greater than one means that Sh_O2 spins slower that Sh_O1. A gear efficiency of less than 1.0 means that Sh_O2 has less power than Sh_O1. - It is important to note that a spring constant should always be input. This is even true when the user wants to go from a rigid to broken shaft. In this case, the spring constant should be input with a large enough value that the shaft dynamics are not a factor in the engine transient. - Finally, this element should generally have a guess function supplied. (Zero torque is a bad value.) A good guess would be to guess the deflection angle as the torque supplied by the turbine divided by the spring constant.
Slinger adds torque to a shaft imposed by shaft-fed fuel delivery system.
Variables
Variable Description Default Units IO Status
Vrim Slinger rim surface speed at injection point 0 ft/sec output
Wfuel Fuel flow rate delivered to slinger 0 lbm/hr output
WfuelName String that points to the fuel flow none input
pwr Power extracted from the shaft 0 hp output
rRim Radius of the slinger 1 in input
trq Torque from fuel delivery 0 ft*lbf output
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
Sh_O ShaftOutputPort Shaft output port
Usage Notes
Slinger - This element is intended to be used in conjunction with the engine spool that includes the main burner and uses a shaft fed fuel delivery scheme. Injecting or slinging the fuel into the burner consumes shaft power and is based on the fuel delivery rate and the change in radius that occurs as it is pumped into the burner.
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
Fl_01 FluidOutputPort Fluid outlet port 1
Fl_02 FluidOutputPort Fluid outlet port 2
Fl_I FluidInputPort Inlet fluid port
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-105
Sockets
Socket Description socketType Sets Values
S_dP Primary and secondary pressure loss socket SPLITTER_DP dPqP1, dPqP2
Independents
Name Description Default Active When
ind_BPR Bypass ratio independent BPR switchDes=OFFDESIGN
Usage Notes
Splitter - The splitter element takes one entering stream and splits it into two streams and applies a pressure loss to each flow separately. This splitter applies to streams that flow only in one direction at all times and do not recirculate.
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
Fl_I FluidInputPort Inlet fluid port
Fl_O1 FluidOutputPort Fluid outlet port 1
Fl_O2 FluidOutputPort Fluid outlet port 2
Sockets
Socket Description socketType Sets Values
S_dP Stream 1 and stream 2 pressure loss socket SPLITTER_DP dPqP1, dPqP2
Independents
Name Description Default Active When
ind_BPR Bypass ratio independent BPR switchDes=OFFDESIGN
Usage Notes
SplitterNASA - The splitter element takes one entering stream and splits it into two streams and applies a pressure loss to each flow separately. This splitter applies to streams that flow only in one direction at all times and do not recirculate.
A Turbine expands incoming flow to provide power to a shaft element. The turbine element performs high-level turbine performance calculations. The performance can be calculated in terms of efficiency, temperature ratio, or delta-h/T. This element is usually used with a map subelement.
Variables
Variable Description Default Units IO Status
HbldSum Sum of the actual enthalpy changes for all the bleed flows
0 Btu/sec output
Nc Corrected speed 0 rpm output
Np Corrected speed 0 rpm/SQRT_R output
NpBase Temporary location for corrected speed 0 rpm/SQRT_R output
NpDes Design corrected speed 0 rpm/SQRT_R output
NpqNpDes Ratio of current corrected speed to design corrected speed
0 rpm/SQRT_R output
PR Pressure ratio 0 none output
PRbase Pressure ratio before application of component modifiers
1 none output[*]
Qhx Heat transfer absorbed by (+) or returned from (-) metal mass
0 Btu/sec output[*]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-108
TR Temperature ratio 0 none output
TRbase Temperature ratio before application of component modifiers
1 none output[*]
WbldSum Sum of the bleed weight flows 0 lbm/sec output
WpBase Corrected weight flow before application of component modifiers
0 lbm/sec output[*]
WpDes Corrected weight flow at design 0 lbm/sec output
S_swirl Socket to calculate exit swirl SWIRL angSwirl
Usage Notes
Turbine - The turbine can be set up to run in three different ways. The first way is to calculate the exit conditions based on input pressure ratio and efficiency. The second way is to calculate the exit conditions based on input pressure ratio and temperature ratio. The third way is to calculate the exit conditions based on input pressure ratio and dhqT. Which type of calculation to use (efficiency, temperature ratio, or delta-h/T) is determined by switchEff. In general, these input values will be determined by one or more map subelements. - The use of switchDes depends on interpretation by the turbine's active subelement(s). - The turbine determines the overall torque produced. This torque is passed
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-110
to its connected shaft through its mechanical port. - Any number of bleed input ports may be defined at run-time. These ports allow the user to input a total pressure 'rise' fraction, and an effective pumping diameter. The pressure fraction is input to specify at what point along the turbine the bleed flow enters. The pumping diameter is used to determine a bleed pumping power due to the fact that the flow is entering from rotor and has some energy due to the tangential movement of the flow. See the User Guide section on “Turbine Element Bleed Entry.” - To determine the effect of the bleed flow on the exit conditions, the bleeds are isentropically expanded to the exit pressure. This allows an ideal enthalpy to be determined. This ideal enthalpy is transformed to an actual enthalpy using the efficiency calculated from the map. This actual enthalpy is then used in an energy balance with the primary stream to determine the actual exit conditions. - Component modifiers are used when the switchAud Option Switch is set to AUDIT. - Use of modifiers: variable = s_variableAud * variableBase + a_variableAud - Adding a turbine element to an engine will invariable result in a solver independent and dependent. With NPSS, the solver independent and dependent area tied to the map that is used. - The heat transfer calculations area performed after all the other calculations are done. This means that if heat transfer is being used, the exit temperature will not match the value indicated by the efficiency and temperature ratio. - Additionally, the user can request a thermal mass. This thermal mass allows the user to input metal properties and a weighting factor on the entrance and exit temperatures to determine the driving temperature. For example, if a value of .4 is input, the driving temperature is .4*Tin + .6*Tout. The heat transfer calculations are performed after all the other calculations are done. This means that if heat transfer is being used, the exit temperature will not match the value indicated by the efficiency and temperature ratio. - The turbine also has a socket available to supply a swirl exit angle.
Turbine has a baseType of Element.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-111
[ Back to Index ]
2.46 VariableContainer Prototype Description void ESOreport (int, string) Informs the errHandler that an error or warning condition has been encountered
void addInterface (string) Allows user to add an interface to the object by supplying the desired interface as a single string argument
void copy (string, string) Makes a duplicate of the object specified by the first string and gives it the name specified by the second string
void create (string, string, string) Creates an object of a given baseType and type with the given instance names (all supplied as strings)
void delete (string) Deletes the object supplied as a string void dump (int) dumps names and values of variables void error (string, int) Generates an error message any evalExpr (string) Evaluates an expression any getVal (string) Returns the contents of the string string[] getVarAttributes () Returns a string containing the attributes of a variable for a specified element
void initChildHistories () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations in child objects
void initializeHistory () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations
string[] list (string, int) Returns a list of sorted objects; each must match the given type (e.g. 'Element') AND return TRUE for the given expression.
void loadCompiledObjects (string, string) loads pre-compiled objects into the current scope
void message (string) Generates an informational message void move (string, string) Moves object specified by the first string to the location specified by the second string void needVerify () Tells the system that verify() should be run the next time this component is executed void parseEfile (string, string) Processes an encrypted NPSS input file, executing the commands within void parseFile (string) Processes an NPSS input file, executing the commands within void parseString (string) Reads in and executes the given string void provisionalError (string, int) Generates a provisional error message void provisionalWarning (string, int) Generates a provisional warning message
int setOption (string, any) Sets the variable with a given name in and below the scope in which this function is called. When setting the variable's name to a string, the desired value must be in quotes
void setVal (string, any) Assigns the string ref name or attribute, if given
void throwError (string, int) Breaks the flow of execution and generates an error message. If called from interpreted code, execution will resume on the next statement in interpretive code.
void tree () Displays a hierarchical view of the Model presented in execution sequence. Elements are listed in the order defined in solver sequence array. Elements not named there are listed next.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-112
string[] treePath () Constructs a string array which represents a hierarchical view of the model
void updateChildHistories () Updates internal variable and time-dependent histories after the model has converged at the current time-step in child objects
void updateHistory () Updates internal variable and time-dependent histories after the model has converged at the current time-step
void variableChanged (string, any) Shows which option variables have been changed. Is called on the component whenever the value of the variable is set, unless the Option's trigger attribute is FALSE.
void warning (string, int) Generates a warning message VariableContainer has a baseType of VariableOnlyContainer.
[ Back to Index ]
2.47 VariableOnlyContainer VariableOnlyContainer has a baseType of VCInterface.
[ Back to Index ]
2.48 VCInterface
Functions
Prototype Description void VCinit () Contains instructions that will be executed upon instantiation int exists (string) Returns TRUE if the object exists in the model, FALSE if it does not string getDataType () Returns the data type of the object string getName () Returns the object's local name string getParentName () Returns the object's parent's name
string getPathName () Returns the object's full pathname string getTextRep (int) Returns ASCII text representation of the object int hasInterface (string)
Returns TRUE if the single string argument matches an interface the objects supports. If the argument does not match, returns FALSE.
int hidden () Returns 1 if the object is hidden (won't display in a list), 0 if not hidden
void hide (int) If value=0, object is not hidden. If value=1, object will not display in lists or in AutoDoc output. If value=2, same as value=1 and in addition, upon conversion to C++, the object will not be user accessible at all
string isA () Returns the type of the object string[] listInterfaces () Returns a string array containing all the interfaces that the object supports
void whenDeleted (string) Determines if no message, Warning message, or Error message is sent if the object is deleted
Wall provides a means of transferring heat from one stream to another.
Variables
Variable Description Default Units IO Status Ahx1 Heat transfer wetted area 1 0 in2 input Ahx2 Heat transfer wetted area 2 0 in2 input Chx1 Stream 1 heat transfer film coefficiency 0 Btu/(sec*in2*R) output Chx2 Stream 2 heat transfer film coefficient 0 Btu/(sec*in2*R) output ChxDes1 Stream 1 design heat transfer film coefficient 0 Btu/(sec*in2*R) input ChxDes2 Stream 2 design heat transfer film coefficient 0 Btu/(sec*in2*R) input CpMat Specific heat of the material 0 Btu/(lbm*R) input Qhx1 Heat from the material to stream 1 0 Btu/sec output Qhx2 Heat from the material to stream 2 0 Btu/sec output TgasPath Average gaspath temperature 0 R output Tmat Material temperature 0 R output Wdes1 Stream 1 design value of the weight flow 0 lbm/sec output Wdes2 Stream 2 design value of the weight flow 0 lbm/sec output dTmatqdt Rate of material temp change 0 R/sec output effect Resulting heat exchanger effectiveness 0 none output expChx1 Stream 1 exponent used in the film coefficiency
correlation 0.8 none input
expChx2 Stream 2 exponent used in the film coefficiency correlation
0.8 none input
kcDes1 Stream 1 heat transfer conductivity of the gas at design
0 Btu/(sec*in*R) output by default input when switchDes=OFFDESIGN
kcDes2 Stream 2 heat transfer conductivity of the gas at design
0 Btu/(sec*in*R) output by default input when switchDes=OFFDESIGN
massMat Mass of the structural material 0 lbm input
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-114
muDes1 Stream 1 design value of flow viscosity 0 lbm/(in*sec) output by default input when switchDes=OFFDESIGN
muDes2 Stream 2 design value of flow viscosity 0 lbm/(in*sec) output by default input when switchDes=OFFDESIGN
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
Fl_I1 FluidInputPort First inlet flow
Fl_I2 FluidInputPort Second inlet flow
Fl_O1 FluidOutputPort First outlet flow
Fl_O2 FluidOutputPort Second outlet flow
Independents
Name Description Default Active When
ind_Tmat Default independent to vary material temperature Tmat switchDes=DESIGN, OFFDESIGN
Dependents
Name Description eq_lhs eq_rhs Active When
integ_Tmat Default integrator to balance out the net heat flow -Qhx2 Qhx1 switchDes=DESIGN, OFFDESIGN
Usage Notes
Wall - The wall element allows the user to transfer heat from one stream to another through a material mass. The heat transfer between the material mass and the two streams is calculated based on the temperature of the material mass, fluid flow conditions, and the fluid transport properties. - In steady-state mode, the temperature needs to be varied until the heat flowing from the material mass to one stream is equal to the heat from the material mass to the other stream. In transient mode, the heat flux into the material mass is calculated and used to determine a temperature derivative. The derivative
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Element Reference Sheets 2-115
is then integrated to determine the temperature. - The overall effectiveness of the heat transfer process is calculated. Thus, this element can be used as a poor man's heat exchanger. To do this, one of the wall inputs needs to be varied by the solver to get the desired effectiveness.
void variableChanged (string name, any oldVal) None
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-3
Ports and Internal Stations
Port/Station Type Description
Fl_Icomb FlowStation Flow station from parent
Sockets
Socket Description socketType Sets Values
TB_eff Burner efficiency versus Wc and FAR Function
Usage Notes
BurnEfficiency - This subelement calculates the enthalpy based burner efficiency as a function of the burner corrected airflow and fuel-to-air ratio. The efficiency is calculated from a required table, TB_eff, of unscaled efficiency versus corrected airflow and fuel-to-air ratio. In design mode, this subelement will calculate an appropriate adder or scalar to match the table value with the user supplied design value. - It is assumed that if the user is using this subelement, he/she desires to represent all the burner inefficiencies in the enthalpy based efficiency term. As such, the temperature based effChem is set to 1.0 and returned to the parent burner.
TB_Wc Corrected flow versus alpha, Rline and speed Function
TB_eff Efficiency versus alpha, Rline, and speed Function
Other Objects
Name Type Description
smSolver SecantSolver Solve for NcStall keeping flow constat
Usage Notes
CompressorEfficiencyMap - This subelement is designed to read efficiency maps. Three tables are required, TB_eff for efficiency maps, TB_PR for pressure ratio maps, and TB_Wc for corrected flow maps. The higher level element supplies values of NcMap, RlineMap, and alphaMap -- which are the table independents. The element will then read three maps to determine the unscaled values or Wc, PR, and efficiency. These values are returned to the higher level where they are scaled. Additionally, it is assumed that one of the Rlines represents the stall line. This Rline is used to calculate a stall margin at constant speed and constant flow. - The tables themselves are input as a function of Rline for different sets of speed. The tables are also three dimensional in nature. The user is required to input values as a function of alpha. If the maps being used are not three dimensional, then the user should repeat the existing map for different alpha to make the map constant as a function of this value.
CompressorEfficiencyMap has a baseType of Subelement.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-6
[ Back to Index ]
3.4 CompressorHumidityEffects
CompressorHumidityEffects calculates the effect of humidity on compressor performance for an efficiency based map.
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
Fl_Iint FlowStation internal inlet flow station
Usage Notes
CompressorHumidityEffects - This subelement is designed to calculate the effects of humidity on compressor efficiency maps. The higher level element supplies values of map gas constant, map gamma, and map pressure ratio. The subelement returns a speed scalar, weight flow scalar, and pressure ratio scalar. In general, speed is an input into a performance map. This speed scalar is applied to adjust this value before the maps are read. The other scalars are used to adjust the map calculated values. - The subelement works by taking map values -- pressure ratio, gamma and gas constant -- and using them to calculate performance modifiers based on the actual values of gamma and gas constant at the compressor inlet. - For power coefficient calculations, air is assumed to be a perfect gas. - The methods used to calculate these corrections are based on correlations derived in the Humidity Appendix.
CompressorHumidityEffects has a baseType of Subelement.
CompressorMap - NOTE TO USERS: This subelement is becoming obsolete. It will not accept the design values from the parent. You must still enter them here. - This subelement manages the compressor performance calculations for an efficiency based map. It is responsible for matching the unscaled map data based on design data supplied by the user. Additionally, it is also responsible for performing the overall compressor mass balance. The compressor default solver independent and dependent are located at this level. - This subelement has three sockets that perform the actual performance calculations. The map socket calculates the unscaled compressor performance based on the user supplied maps. The humidity effects socket calculates adjustment factors based on changes in humidity. The Reynolds effects socket calculates adjustment factor based on changes in Reynolds number.
CompressorMap has a baseType of Subelement.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-10
[ Back to Index ]
3.6 CompressorReynoldsEffects
CompressorReynoldsEffects calculates the effects of changing Reynolds number on performance for compressor efficiency maps.
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
Fl_Iint FlowStation internal inlet flow station
Usage Notes
CompressorReynoldsEffects - This subelement is designed to calculate the effects of changing Reynolds numbers on compressor efficiency map. The higher level element supplies values of corrected weight flow and Reynolds number at design. The subelement returns an efficiency scalar and a weight flow scalar representing the Reynolds effects. These scalars are used to adjust the map calculated values. - The subelement works by taking map values of corrected weight flow and Reynolds number at design and adjusting them for the actual inlet conditions. - The methods used to calculate these corrections are based on correlations derived in the Reynolds Correction Appendix.
CompressorReynoldsEffects has a baseType of Subelement.
switchTR switch indicating if Trise map or Temp Ratio map should be used [ TRISE, TR]
None TRISE TRISE, TR
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-12
Functions
Prototype Description
void calculate () None
Sockets
Socket Description socketType Sets Values
TB_PR Temperature rise table, returns TriseMap Function
TB_PRstall Temperature rise table, returns TriseMap Function
TB_Trise Temperature rise table, returns TriseMap Function
TB_Wc Temperature rise table, returns TriseMap Function
Other Objects
Name Type Description
smSolverFlow SecantSolver Solve for EMlineSMN at stall keeping speed constant
Usage Notes
CompTempMap - NOTE TO USERS: This subelement is becoming obsolete. It will not accept the design values from the parent. You must still enter them here. - This subelement is designed to read temperature maps. The four required maps are TB_PR, TB_Wc, TB_PRstall, and TB_Trise or TB_TR, depending on if there is a temperature rise or a temperature ratio map. The higher level element supplies values of NcMap, EMlineMap, and alphaMap -- which are the table independents. The element will then read three maps to determine the unscaled values of Wc, PR, and Trise. These values are returned to the higher level where they are scaled. Additionally, the pressure ratio at stall can be input as a function of pressure ratio. When it is, a stall margin at constant flow and a stall margin at constant speed are calculated. - There are two ways for the temperature rise to be input into this subelement. It can either be input as a function of delta T over T [(Tout - Tin)/ Tin] or temperature ratio [Tout / Tin]. If the value is input as a temperature ratio, then it is changed to a delta T over T by subtracting 1. Delta T over T is the value that is returned to the parent. - The tables themselves are input as a function of EMline for different sets of speed. The tables are also three dimensional in nature. The user is required to input values as a function of alpha. If the maps being used are not three dimensional, then the user should repeat the existing map for a different alpha. - It is important to note that all maps are assumed to be corrected to standard day values of inlet temperature and pressure and zero
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-13
humidity (i.e., dry air at standard day conditions) before being fitted. If this is not the case, then the actual inlet conditions of the map must be known.
CompTempMap has a baseType of Subelement.
[ Back to Index ]
3.8 CompTempMapHum CompTempMapHum calculates the effect of humidity on compressor performance for a temperature based map.
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
Fl_Iint FlowStation internal inlet flow station
Usage Notes
CompTempMapHum - This subelement is designed to calculate the effects of humidity on compressor temperature maps. The higher level element supplies values of map gas constant, map gamma, and map pressure ratio. The subelement returns a speed scalar, temperature scalar, weight flow scalar, and pressure ratio scalar. In general, speed is an input into a performance map. This speed scalar is applied to adjust this value before the maps are read. The other scalars are used to adjust the map calculated values. - The subelement works by taking map values -- pressure ratio, gamma and gas constant -- and using them to calculate performance modifiers based on the actual values of gamma and gas constant at the compressor inlet. - The methods used to calculate these corrections are based on correlations derived in the Humidity Appendix.
CompTempMapHum has a baseType of Subelement.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-14
[ Back to Index ]
3.9 CompTempMapRe CompTempMapRe calculates the effects of changing Reynolds on performance for compressor temperature maps.
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
Fl_Iint FlowStation internal inlet flow station
Usage Notes
CompTempMapRe - This subelement is designed to calculate the effects of changing Reynolds numbers on compressor performance. The higher level element supplies values of corrected weight flow and Reynolds number at design. The subelement returns a temperature scalar and a weight flow scalar representing the Reynolds effects. Theses scalars are used to adjust the map calculated values. - The subelement works by taking map values of corrected weight flow and Reynolds number at design and adjusting them for the actual inlet conditions. - The methods used to calculate theses corrections are based on correlations derived in the Reynolds Correction Appendix.
CompTempSub - This subelement manages the compressor performance calculations for a temperature based map. It is responsible for matching the unscaled map data based on design data supplied by the user. Additionally, it is also responsible for performing the overall compressor mass balance. The compressor default solver independent and dependent are located at this level. - This subelement has three sockets that perform the actual performance calculations. The map socket calculates the unscaled compressor performance based on the user supplied maps. The humidity effects socket calculates adjustment factors based on changes in humidity. The Reynolds effects socket calculates adjustment factor based on changes in Reynolds number.
TB_PsRecov Pressure recovery versus adjusted length to height ratio
TB_deds Deds versus swirl
TB_lqh Optimum length to height ratio versus length
Usage Notes
dPdiffuser - This subelement returns the scaled normalized pressure drop (delta P/P), dPqP, to the parent element. The Mach number and the exit pressure are used to calculate the total outlet pressure, which is then used to get dPqP. The exit pressure is calculated from the pressure recovery, which is a function of the area ratio, adjusted length, and swirl angle. The Mach number is estimated by assuming that gamma is constant, which will not exactly match the results from the flow station. - Three tables are required for this subelement. TB_lqh returns the optimum length to height ratio when the area ratio is passed in. TB_PsRecov returns a pressure recovery factor when the adjusted length to height ratio is passed in. TB_deds returns a 'deds' value based on the swirl angle. It is used to get the pressure recovery ratio. Reference: AH Lefebvre, Gas Turbine Combustion, Hemisphere Publishing 1983 Reference: pg. 88
switchMatch Switch that controls how the design value is matched [SCALAR / ADDER]
None SCALAR SCALAR, ADDER
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-21
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
Sockets
Socket Description socketType Sets Values
TB_Closs Loss Coefficient Table: Closs is read from table using MNmap and RNI. Function
Usage Notes
dPqP - This subelement returns the scaled normalized pressure drop (delta P/P), dPqPbase. It obtains the total pressure loss in an adiabatic constant area duct. Relatively small Mach Number changes are assumed so that a full Fanno Line solution does not have to be used. Mach Number influences on the total pressure loss must be tabulated into the loss variation table, TB_Closs. The loss coefficient table reads Closs using MNmap and RNI. The inlet flow station is from the parent.
dPqP has a baseType of Subelement.
[ Back to Index ]
3.13 dPqPMach dPqPMach performs a pressure loss calculation based on the inlet Mach number.
Variables
Variable Description Default Units IO Status
dPqPMNbase relative pressure loss returned to parent 0 none output
dPqPMNdes design point pressure loss 0 none input by default output when switchDes=OFFDESIGN
expMN Exponent on Mach number 1 none input by default output when switchDes=OFFDESIGN
s_dPqPMN scalar for dPqPMN 1 none input by default output when switchDes=DESIGN
switchDes flag indicating design/off-design s_dPqPMN, dPqPMNdes, expMN DESIGN DESIGN, OFFDESIGN
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-22
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
Usage Notes
dPqPMach - This subelement returns the scaled normalized pressure drop (delta P/P), dPnormBase. The pressure loss is calculated as a function of the incoming Mach raised to a user-supplied exponent.
dPqPMach has a baseType of Subelement.
[ Back to Index ]
3.14 ElementBase
Variables
Variable Description Default Units IO Status
version particular version of each component input
Functions
Prototype Description
void clearSolverTerms () Sets the autoSetup flag to FALSE for all objects in the Solver. Objects aren't removed until autoSolverSetup is called.
void execute () Runs a sequence of commands specified by user to execute current Element/Subelement
string getExecutive () get the current executive
int getPassType () Identifies the current Model pass as the first pass of a convergence attempt (0), a matrix generation (perturbation) pass (1) or an iteration pass (2)
string[] listSocketTypes () function deprecated
void prePass () None
void run () Orders Solver to solve Model for a single point with the current input conditions
void setExecutive (string) set the current executive
void setupExecutive (int) set up the current executive
int varNameIsActiveIndep (string)
Determines if the given full variable pathname corresponds to the model variable controlled by any independents in the Solver
int verify () Returns 1 (TRUE) if the Model is valid, 0 (FALSE) if it is not
switchMatch Determines whether to match design recovery with adder or scalar
None SCALAR SCALAR, ADDER
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
Sockets
Socket Description socketType Sets Values
TB_rec Ram Recovery Table Function
Usage Notes
ramRecovery - This subelement calculates inlet recoveries. The user can either input a table of recovery versus Mach number or allow the subelement to calculate the recovery based on the military specification MIL-E-5007E. Some older documents refer to MIL-E-5008C, be aware that 5008C has a note that states *** Specification MIL-E-5008C,30 DEC 1965, is hereby canceled. *** *** It has been superceded by MIL-E-5007E. 30, OCT 1973 *** - The table used for the recovery is TB_rec.
RecoveryFactor will correct an Instrument Element temperature reading for recovery effects.
Variables
Variable Description Default Units IO Status
MN Mach number (read from MNname) 0 none output
MNname String giving model Mach number used to read the table none output
TR Ratio of corrected to measured temperature 0 R output
Tdel Delta between corrected and measured temperature 0 R output
Ts Static temperature (read from TsName) 0 R output
TsActual Temperature corrected for recovery effects (returned to parent as measAdj) 0 R output
TsName String giving model static Temperature to use for recover factor calculation none input
recFactor Recovery factor (read from table TB_recFactor) 0 none input
Functions
Prototype Description
void calculate () None
int verify () None
Sockets
Socket Description socketType Sets Values
TB_recFactor Recovery factor versus Mach number Function
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-29
Usage Notes
RecoveryFactor - The Recovery Factor Subelement corrects an Instrument Element temperature reading for recovery effects. To use this subelement, the user inputs a table of recovery values versus Mach numbers. The user also supplies a reference to a cycle Mach number and static temperature. The Mach number is used to read a recovery factor table. The recovery factor is applied to the difference between the static temperature and the measured temperature. - This subelement takes the value measAdj from its parent. It is assumed since this subelement is being used, the parent Instrument is reading a temperature. The subelement will return a value of measAdj that represents the original value adjusted for the recovery correction. - This subelement needs a table, TB_recFactor, to run correctly. This table should be a function of the temperature recovery factor versus Mach number.
RecoveryFactor has a baseType of Subelement.
[ Back to Index ]
3.20 RecoveryRatio RecoveryRatio will correct an Instrument Element temperature reading for recovery effects.
Variables
Variable Description Default Units IO Status
MN Mach number (read from MNname) 0 none output
MNname String giving Mach number to read from the cycle to read the table none output
Tdel Delta between corrected and measured temperature 0 R output
TsActual Temperature corrected for recovery effects (returned to parent as measAdj) 0 R output
recRatio Recovery ratio (read from table TB_recRatio) 0 none input
Functions
Prototype Description
void calculate () None
int verify () None
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-30
Usage Notes RecoveryRatio - The RecoveryRatio Subelement corrects an Instrument Element temperature reading for recovery effects. To use this subelement, the user inputs a table of recovery values versus Mach numbers. The recovery values indicate the ratio of measured temperature versus true temperature accounting for the stagnation effects of the sensor. To use this subelement the user must also give a reference to the cycle Mach number that is used to read the recovery table. - This subelement takes the value measAdj from its parent. It is assumed since this subelement is being used, the parent Instrument is reading a temperature. The subelement will return a value of measAdj that represents the original value adjusted for the recovery correction. - This subelement needs a table, TB_recRatio, to run correctly. This table should be a function of the temperature recovery ratio versus Mach number.
RecoveryRatio has a baseType of Subelement.
[ Back to Index ]
3.21 Subelement Subelement has a baseType of ElementBase.
[ Back to Index ]
3.22 TDay TDay adds MIL-STD-210 A & C effects into the model.
Variables
Variable Description Default Units IO Status
dTemp Deviation from Altitude reference static temperature 0 dF output
temp Altitude reference free stream static temperature 0 R output
Option Variables
Variable Description Variables IOStatus Affected
Default Allowed Values
switchTDay Determines TsSTD from an alternate temperature schedule.
TDay - Sets Ts_cmd and dTs_cmd to MIL_210 A & C Type Day Conditions in degrees R. - Note: ZdTs is accumulative with any TDay option
TDay has a baseType of Subelement.
[ Back to Index ]
3.23 ThermalMass ThermalMass adjusts an element's outlet conditions to account for thermal storage.
Variables
Variable Description Default Units IO Status
Ahx Heat transfer area between fluid and material
0 in2 input
Chx Heat transfer coefficient 0 Btu/(sec*in2*R) output
ChxDes Design heat transfer coefficient 0 Btu/(sec*in2*R) input
CpGasPath Weighted average of gas Cp 0 Btu/(lbm*R) output
CpMat Material Cp 0 Btu/(lbm*R) input
TgasPath Weighted average of the gas temperature
0 R output
TgasPathPrev Weighted average of the gas temperature from the previous time
0 R output
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-32
step
Tmat Current material temperature 0 R output
TmatPrev Material temperature from previous time step
0 R output
Wdes Weighted average of the gas weight flow
0 lbm output
dTmatqdt Material temperature time derivative
0 1/sec output
expChx Exponent used in heat transfer coefficient equation
0.8 none input
kcDes Fluid design thermal conductivity 0 Btu/(sec*in*R) output by default input when switchDes=OFFDESIGN
kcMat Material thermal conductivity 1 Btu/(sec*in*R) input
leadLagRatio Equivalent lead lag ratio of the thermal mass system
0 none output by default input when switchLagIn=CONTROLCHAR
massMat Material mass 0 lbm input
muDes Design fluid viscosity 0 lbm/(in*sec) output by default input when switchDes=OFFDESIGN
tau Equivalent time constant of the thermal mass system
0 sec input by default output when switchDes=DESIGN, OFFDESIGN output when switchLagIn=PHYSICAL
thMat Material thickness 0 in input
wtdAvg_Fl Factor used to average the fluid conditions between the inlet and exit of the parent element (1 for element entrance conditions, 0 for element exit conditions)
switchForm Solution form switch None STEP STEP, RAMP, ADD_SOLVER
switchLagIn Determines if the design inputs are tau and leadLagRatio or Ahx and massMat
tau, leadLagRatio PHYSICAL PHYSICAL, CONTROLCHAR
Functions
Prototype Description
void calculate () None
int hasTimeHistory () None
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-33
void initializeHistory () None
void updateHistory () None
void variableChanged (string name, any oldVal) None
Independents
Name Description Default Active When
ind_Tmat Default independent to vary material temperature Tmat switchForm=ADD_SOLVER
Dependents
Name Description eq_lhs eq_rhs Active When
integ_Tmat Default integrator to balance the heat flow TgasPath Tmat switchForm=ADD_SOLVER
Usage Notes
ThermalMass - This subelement will act as a thermal sink and allow for heat transfer from an element's fluid flow to a material mass. This subelement is transient in nature and will have no effect on the parent element during steady-state operation. - The driving fluid properties are determined by a weighted average of the inlet and exit properties. The weighting is controlled by a factor set by the user. - Since this element is transient in nature, the material temperature must be determined through some form of integration. There are three possibilities. The first two, STEP and RAMP, assume a first order lag response to the driving conditions. These functions make assumptions as to nature of the driving function. The third method, ADD_SOLVER, will create an integrator and independent that can be thrown to the solver where the integration will be done.
TurbineEfficiencyMap will read a turbine efficiency map and return the performance values.
Functions
Prototype Description
void calculate () None
Sockets
Socket Description socketType Sets Values
TB_Wp Corrected flow versus geometry, PR, and corrected speed Function
TB_eff Efficiency versus geometry, PR, and corrected speed Function
Usage Notes
TurbineEfficiencyMap - This subelement is designed to read the efficiency maps. Two maps are required, the efficiency table map, TB_eff, and the corrected flow table map, TB_Wp. - The higher element supplies values of parmGeomMap, PRmap and NpMap -- which are the table independents. The element will then read three maps to determine the unscaled values of Wp efficiency. These values are returned to the higher level where they are scaled. - The tables themselves are input as a function of pressure ratio for
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-35
different sets of speed. The tables are also three dimensional in nature. The user is required to input values as a function of parmGeomMap. If the maps being used are not three dimensional, then the user should repeat the existing map for different alpha to make the map constant as a function of this value.
TurbineEfficiencyMap has a baseType of Subelement.
[ Back to Index ]
3.25 TurbineHumidityEffects TurbineHumidityEffects calculates the effect of humidity on turbine performance for an efficiency based map.
Variables
Variable Description Default Units IO Status
PRgamR Pressure ratio adjusted for gamma R effects 0 none input
Rmap Map gas constant 0 Btu/(lbm*R) input
gamMap Map ratio of specific heats 0 none input
Functions
Prototype Description
void calculate () None
Usage Notes
TurbineHumidityEffects - This subelement is designed to calculate the effects of humidity on turbine efficiency maps. The higher level element supplies values of incoming gas constant, gamma, and pressure ratio. The subelement returns a speed scalar, weight flow scalar, and pressure ratio scalar. In general, speed is an input into a performance map. This speed scalar is applied to adjust this value before the maps are read. The other scalars are used to adjust the map calculated values. - The subelement works by taking map values -- pressure ratio, gamma and gas constant -- and using them to calculate performance modifiers based on the actual values of gamma and gas constant at the turbine inlet. - The methods used to calculate these corrections are based on correlations derived in the Humidity Appendix.
TurbineHumidityEffects has a baseType of Subelement.
parmGeomDes Design geometric parameter (see parmGeom) 0 none input by default output when switchDes=OFFDESIGN
parmGeomMap Map geometric parameter (see parmGeom) 0 none output parmMap Map Parameter (used by efficiency subelement to
read the map) 0 none input
parmMapDes Design Map Parameter (see parmMap) 1 none input by default output when switchDes=OFFDESIGN
parmNcDes Design corrected speed 1 none input by default output when switchDes=OFFDESIGN
s_Np Corrected speed design scalar 1 none output by default input when switchDes=OFFDESIGN
s_NpGamR Corrected speed gammaR scalar, calculated by S_eff
1 none output[*]
s_PRgamR Pressure ratio gammaR scalar, calculated by S_hum.
1 none output[*]
s_RNI Reynolds Number Index scalar 1 none input s_Wp Corrected flow design scalar 1 none output by default
input when switchDes=OFFDESIGN s_WpGamR Corrected flow gammaR scalar, calculated by
S_hum 1 none output[*]
s_WpRe Corrected flow Reynolds scalar, calculated by S_Re
1 none output[*]
s_dPqP Pressure ratio design scalar 1 none output by default input when switchDes=OFFDESIGN
s_eff Adiabatic efficiency design scalar 1 none output by default input when switchDes=OFFDESIGN
s_effRe Adiabatic efficiency Reynolds effect scalar, calculated by S_Re
1 none output[*]
s_parmGeom Geometric parameter design scalar 1 none input s_parmMap Map parameter design scalar 1 none input * If the Socket is empty, the IO Status is input (see Sockets)
TurbineNeppMap - This subelement manages the turbine performance calculations for an efficiency based map. It is responsible for matching the unscaled map data based on design data supplied by the user. Additionally, it is also responsible for performing the overall turbine mass balance. The turbine default solver independent and dependent are located at this level. - This subelement has three sockets that perform the actual performance calculations. The map socket calculates the unscaled turbine performance based on the user supplied maps. The humidity effects socket calculates adjustment factors based on changes in humidity. The Reynolds effects socket calculates the adjustment factor based on changes in Reynolds number. - The subelement operates in both DESIGN and OFF-DESIGN mode. In DESIGN mode, the subelement will take the user supplied efficiency and determine a scalar to match it to the map value. In addition, the subelement will determine a scalar that will match the incoming flow with the map flow. Finally, the subelement will determine a scalar to match the design pressure ratio with the map pressure ratio. The design pressure ratio is usually set by the solver. It is determined by matching the power balance between the turbines and compressors on a shaft. If OFF-DESIGN mode, the subelement will determine values of corrected flow and efficiency for input values of pressure ratio using the scalars calculated in DESIGN mode. Once again, the pressure ratio
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-39
is set by the solver. Additionally, the solver will also balance out the weight flow error.
TurbineNeppMap has a baseType of Subelement.
[ Back to Index ]
3.27 TurbineReynoldsEffects TurbineReynoldsEffects calculates the effects of changing Reynolds number on performance for turbine efficiency maps.
Variables
Variable Description Default Units IO Status
ClossRe Reynolds Loss Coefficient 0 none output
PtMap Map Total Pressure 0 psia input
RNImap Map Reynolds Number Index 0 none output
TtMap Map Total Temperature 0 R input
effMap Map Adiabatic Efficiency 1 none input
expEff Exponent on Adiabatic Efficiency Scaling 1 none input
expFlow Exponent on Flow Scaling 1 none input
Functions
Prototype Description
void calculate () None
Usage Notes
TurbineReynoldsEffects - This subelement is designed to calculate the effects of changing Reynolds numbers on a turbine efficiency map. The higher level element supplies the value of the Reynolds Number Index (RNI) and effMap. The subelement returns an efficiency scalar and a weight flow scalar representing the Reynolds effects. These scalars are used to adjust the map calculated values. - The subelement works by taking the current value of RNI and comparing it to the map value of RNI. The map value of RNI is calculated from input values of Pt and Tt representing the conditions for which the map was generated. The two values of RNI are used to determine scale factors on the efficiency and corrected flow.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-40
- The methods used to calculate these corrections are based on correlations derived in the Reynolds Correction Appendix.
TurbineReynoldsEffects has a baseType of Subelement.
Fl_I FlowStation Temporary inlet flow station for pressure loss calculations
Fl_O FlowStation Temporary flow outlet station for pressure loss calculations
Sockets
Socket Description socketType Sets Values
S_dP Valve pressure loss socket ADIAB_DPNORM dPqP
TB_Ae Valve area versus position Function
Other Objects
Name Type Description
MachSolve SecantSolver Solver to match static pressures
Usage Notes
Valve - This Valve subelement models a simple orifice. It controls flow of fluid through the valve from one stream to another. - The flow is driven by the pressure ratio. The total conditions at the valve are expanded to the static conditions at the valve exit. The flow is then determined by the valve area and the static conditions. - The valve area is input in a table, TB_Ae. This table allows the valve area to be varied by inputting a position that is used to read the table.
WireCorrection will correct an Instrument Element temperature reading for wire correction effects.
Variables
Variable Description Default Units IO Status
TR Ratio between real and measured temperature 0 none input
Tdel Delta temperature due to wire correction (read from table) 0 R input
TsActual Actual measured temperature 0 R input
Functions
Prototype Description
void VCinit () None
void calculate () None
Sockets
Socket Description socketType Sets Values
TB_wireCorr Temperature versus temperature Function
Other Objects
Name Type Description
Tsolver SecantSolver Iterate to determine temperature delta between real and measured
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 3-43
Usage Notes
WireCorrection - The Wire Correction Subelement corrects an Instrument Element temperature reading for wire reading effects. The user inputs a table of delta temperature as a function of real temperature. Thus, for any given measured temperature, the user can determine the real temperature that corresponds to it. Since the measured temperature is known and the table is a function of the real temperature, an iteration must be performed until the real temperature plus the indicated delta temperature equals the input measured temperature. - This subelement takes the value measAdj from its parent. It is assumed since this subelement is being used, the parent Instrument is reading a temperature. The subelement will return a value of measAdj that represents the original value adjusted for the wire correction. - This subelement needs a table, TB_wireCorr, to run correctly. This table should be a function of temperature delta verses true temperature. Temperature delta is the difference between true and read temperature.
WireCorrection has a baseType of Subelement.
[ Back to Index ]
3.30 wsfr wsfr has a baseType of Subelement.
[ Back to Index ]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-44
4 Port Reference Sheets
Software Release: NPSS_1.6.4 - Rev: AI Document Generation Date: 01/09/08
Sets the bleed station conditions based on current cycle conditions and bleed inputs.
void updateBleed (real) Calculates current conditions; is used after setBleedStation() has been called at least once. Ideally, call in the calculate() function.
BleedOutPort has a baseType of FluidOutputPort.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-46
[ Back to Index ]
4.2.3 DataInputPort
Variables
Variable Description Default Units IO Status
val 0 unset
Functions
Prototype Description
void execute () Used to optionally call postexecute hook
DataInputPort has a baseType of DataPort.
[ Back to Index ]
4.2.4 DataOutputPort
Variables
Variable Description Default Units IO Status
val 0 unset
Functions
Prototype Description
void execute () Used to optionally call preexecute hook
DataOutputPort has a baseType of DataPort.
[ Back to Index ]
4.2.5 DataPort DataPort has a baseType of Port.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-47
[ Back to Index ]
4.2.6 FluidInputPort
Functions
Prototype Description
string getStation () None
FluidInputPort has a baseType of FluidPort.
[ Back to Index ]
4.2.7 FluidOutputPort
Functions
Prototype Description
string getStation () None
FluidOutputPort has a baseType of FluidPort.
[ Back to Index ]
4.2.8 FluidPort FluidPort has a baseType of Port.
[ Back to Index ]
4.2.9 FuelInputPort FuelInputPort has a baseType of FuelPort.
[ Back to Index ]
4.2.10 FuelOutputPort FuelOutputPort has a baseType of FuelPort.
[ Back to Index ]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-48
4.2.11 FuelPort FuelPort has a baseType of Port.
[ Back to Index ]
4.2.12 InterStageBleedInPort
Variables
Variable Description Default Units IO Status
Pfract Fraction of the total pressure 'rise' associated with the turbine that acts as the sink pressure for the bleed. Pfract = (bleed P - turbine exit P)/(turbine inlet P - turbine exit P). If Pfract is equal to 1, bleed introduced at the turbine inlet. If Pfract is equal to 0, bleed introduction at the turbine exit.
0 none input
bldPumpPwr Pump power used by the bleed impeller. 0 hp output
diaPump Effective pumping diameter used to calculate the power used to accelerate the bleed flow to the rotational speed of the turbine blades.
0 in input
stageID Component stage identifier. 0 none input
Functions
Prototype Description
void bleedPumpPower (real, real, real)
Computes bleed pumping power as a function of shaft speed, turbine entrance pressure, and turbine exit pressure. This function also sets the bleed port's flow stations.
string getStation () None
void setStation () Sets the element flow stations to the bleed port.
InterStageBleedInPort has a baseType of FluidInputPort.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-49
[ Back to Index ]
4.2.13 InterStageBleedOutPort
Variables
Variable Description Default Units IO Status
Wbld Bleed flow 0 lbm/sec input by default output when switchFlow=FRACT, FRACT_LOCAL
Wlocal Component flow at bleed location 0 lbm/sec input
4.2.16 ReactedFluidPort ReactedFluidPort has a baseType of Port.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-51
[ Back to Index ]
4.2.17 ShaftInputPort
Variables
Variable Description Default Units IO Status
Nmech Mechanical speed of the shaft. ??? unset
pwr Power on the shaft. ??? unset
Functions
Prototype Description void ESOreport (int, string) Informs the errHandler that an error or warning condition has been encountered void VCinit () Contains instructions that will be executed upon instantiation
void addInterface (string) Allows user to add an interface to the object by supplying the desired interface as a single string argument
void copy (string, string) Makes a duplicate of the object specified by the first string and gives it the name specified by the second string
void create (string, string, string) Creates an object of a given baseType and type with the given instance names (all supplied as strings)
void delete (string) Deletes the object supplied as a string void dump (int) dumps names and values of variables void error (string, int) Generates an error message any evalExpr (string) Evaluates an expression int exists (string) Returns TRUE if the object exists in the model, FALSE if it does not string getDataType () Returns the data type of the object real getInertia () None any getLinkName () None any getLinkedPortName () None string getName () Returns the object's local name string getParentName () Returns the object's parent's name string getPathName () Returns the object's full pathname string getTextRep (int) Returns ASCII text representation of the object real getTrq () None any getVal (string) Returns the contents of the string string[] getVarAttributes () Returns a string containing the attributes of a variable for a specified element
int hasInterface (string) Returns TRUE if the single string argument matches an interface the objects supports. If the argument does not match, returns FALSE.
int hidden () Returns 1 if the object is hidden (won't display in a list), 0 if not hidden
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-52
void hide (int) If value=0, object is not hidden. If value=1, object will not display in lists or in AutoDoc output. If value=2, same as value=1 and in addition, upon conversion to C++, the object will not be user accessible at all
void initChildHistories () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations in child objects
void initializeHistory () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations
string isA () Returns the type of the object string isLinkedTo () None
string[] list (string, int) Returns a list of sorted objects; each must match the given type (e.g. 'Element') AND return TRUE for the given expression.
string[] listInterfaces () Returns a string array containing all the interfaces that the object supports void loadCompiledObjects (string, string) loads pre-compiled objects into the current scope void message (string) Generates an informational message void move (string, string) Moves object specified by the first string to the location specified by the second string void needVerify () Tells the system that verify() should be run the next time this component is executed void parseEfile (string, string) Processes an encrypted NPSS input file, executing the commands within void parseFile (string) Processes an NPSS input file, executing the commands within void parseString (string) Reads in and executes the given string void provisionalError (string, int) Generates a provisional error message void provisionalWarning (string, int) Generates a provisional warning message void setNmech (real) None
int setOption (string, any) Sets the variable with a given name in and below the scope in which this function is called. When setting the variable's name to a string, the desired value must be in quotes
void setSpeedRef (string) None void setVal (string, any) Assigns the string ref name or attribute, if given
void throwError (string, int) Breaks the flow of execution and generates an error message. If called from interpreted code, execution will resume on the next statement in interpretive code.
void tree () Displays a hierarchical view of the Model presented in execution sequence. Elements are listed in the order defined in solver sequence array. Elements not named there are listed next.
string[] treePath () Constructs a string array which represents a hierarchical view of the model
void updateChildHistories () Updates internal variable and time-dependent histories after the model has converged at the current time-step in child objects
void updateHistory () Updates internal variable and time-dependent histories after the model has converged at the current time-step
void variableChanged (string, any) Shows which option variables have been changed. Is called on the component whenever the value of the variable is set, unless the Option's trigger attribute is FALSE.
int verify () None void warning (string, int) Generates a warning message
void whenDeleted (string) Determines if no message, Warning message, or Error message is sent if the object is deleted
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-53
[ Back to Index ]
4.2.18 ShaftOutputPort
Variables
Variable Description Default Units IO Status
Nmech Mechanical speed of the shaft. ??? unset
inertia Inertia of the shaft itself. 0 unset
pwr Power on the shaft. ??? unset
trq Torque 0 unset
Functions
Prototype Description void ESOreport (int, string) Informs the errHandler that an error or warning condition has been encountered void VCinit () Contains instructions that will be executed upon instantiation
void addInterface (string) Allows user to add an interface to the object by supplying the desired interface as a single string argument
void copy (string, string) Makes a duplicate of the object specified by the first string and gives it the name specified by the second string
void create (string, string, string) Creates an object of a given baseType and type with the given instance names (all supplied as strings)
void delete (string) Deletes the object supplied as a string void dump (int) dumps names and values of variables void error (string, int) Generates an error message any evalExpr (string) Evaluates an expression int exists (string) Returns TRUE if the object exists in the model, FALSE if it does not string getDataType () Returns the data type of the object any getLinkName () None any getLinkedPortName () None string getName () Returns the object's local name real getNmech () None string getParentName () Returns the object's parent's name string getPathName () Returns the object's full pathname string getTextRep (int) Returns ASCII text representation of the object any getVal (string) Returns the contents of the string string[] getVarAttributes () Returns a string containing the attributes of a variable for a specified element
int hasInterface (string) Returns TRUE if the single string argument matches an interface the objects supports. If the argument does not match, returns FALSE.
int hidden () Returns 1 if the object is hidden (won't display in a list), 0 if not hidden
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-54
void hide (int) If value=0, object is not hidden. If value=1, object will not display in lists or in AutoDoc output. If value=2, same as value=1 and in addition, upon conversion to C++, the object will not be user accessible at all
void initChildHistories () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations in child objects
void initializeHistory () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations
string isA () Returns the type of the object string isLinkedTo () None
string[] list (string, int) Returns a list of sorted objects; each must match the given type (e.g. 'Element') AND return TRUE for the given expression.
string[] listInterfaces () Returns a string array containing all the interfaces that the object supports void loadCompiledObjects (string, string)
loads pre-compiled objects into the current scope
void message (string) Generates an informational message void move (string, string) Moves object specified by the first string to the location specified by the second string void needVerify () Tells the system that verify() should be run the next time this component is executed void parseEfile (string, string) Processes an encrypted NPSS input file, executing the commands within void parseFile (string) Processes an NPSS input file, executing the commands within void parseString (string) Reads in and executes the given string void provisionalError (string, int) Generates a provisional error message void provisionalWarning (string, int) Generates a provisional warning message
int setOption (string, any) Sets the variable with a given name in and below the scope in which this function is called. When setting the variable's name to a string, the desired value must be in quotes
void setTrq (real) None void setVal (string, any) Assigns the string ref name or attribute, if given
void throwError (string, int) Breaks the flow of execution and generates an error message. If called from interpreted code, execution will resume on the next statement in interpretive code.
void tree () Displays a hierarchical view of the Model presented in execution sequence. Elements are listed in the order defined in solver sequence array. Elements not named there are listed next.
string[] treePath () Constructs a string array which represents a hierarchical view of the model
void updateChildHistories () Updates internal variable and time-dependent histories after the model has converged at the current time-step in child objects
void updateHistory () Updates internal variable and time-dependent histories after the model has converged at the current time-step
void variableChanged (string, any)
Shows which option variables have been changed. Is called on the component whenever the value of the variable is set, unless the Option's trigger attribute is FALSE.
int verify () None void warning (string, int) Generates a warning message
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-55
void whenDeleted (string) Determines if no message, Warning message, or Error message is sent if the object is deleted
[ Back to Index ]
4.2.19 ThermalInputPort
Variables
Variable Description Default Units IO Status
MassTemp Mass temperature 0 unset
Functions
Prototype Description void ESOreport (int, string) Informs the errHandler that an error or warning condition has been encountered void VCinit () Contains instructions that will be executed upon instantiation
void addInterface (string) Allows user to add an interface to the object by supplying the desired interface as a single string argument
void copy (string, string) Makes a duplicate of the object specified by the first string and gives it the name specified by the second string
void create (string, string, string) Creates an object of a given baseType and type with the given instance names (all supplied as strings)
void delete (string) Deletes the object supplied as a string void dump (int) dumps names and values of variables void error (string, int) Generates an error message any evalExpr (string) Evaluates an expression int exists (string) Returns TRUE if the object exists in the model, FALSE if it does not string getDataType () Returns the data type of the object any getLinkName () None any getLinkedPortName () None string getName () Returns the object's local name string getParentName () Returns the object's parent's name string getPathName () Returns the object's full pathname string getTextRep (int) Returns ASCII text representation of the object any getVal (string) Returns the contents of the string string[] getVarAttributes () Returns a string containing the attributes of a variable for a specified element
int hasInterface (string) Returns TRUE if the single string argument matches an interface the objects supports. If the argument does not match, returns FALSE.
int hidden () Returns 1 if the object is hidden (won't display in a list), 0 if not hidden void hide (int) If value=0, object is not hidden. If value=1, object will not display in lists or in AutoDoc
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-56
output. If value=2, same as value=1 and in addition, upon conversion to C++, the object will not be user accessible at all
void initChildHistories () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations in child objects
void initializeHistory () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations
string isA () Returns the type of the object string isLinkedTo () None
string[] list (string, int) Returns a list of sorted objects; each must match the given type (e.g. 'Element') AND return TRUE for the given expression.
string[] listInterfaces () Returns a string array containing all the interfaces that the object supports void loadCompiledObjects (string, string) loads pre-compiled objects into the current scope
void message (string) Generates an informational message void move (string, string) Moves object specified by the first string to the location specified by the second string void needVerify () Tells the system that verify() should be run the next time this component is executed void parseEfile (string, string) Processes an encrypted NPSS input file, executing the commands within void parseFile (string) Processes an NPSS input file, executing the commands within void parseString (string) Reads in and executes the given string void provisionalError (string, int) Generates a provisional error message void provisionalWarning (string, int) Generates a provisional warning message
int setOption (string, any) Sets the variable with a given name in and below the scope in which this function is called. When setting the variable's name to a string, the desired value must be in quotes
void setVal (string, any) Assigns the string ref name or attribute, if given
void throwError (string, int) Breaks the flow of execution and generates an error message. If called from interpreted code, execution will resume on the next statement in interpretive code.
void tree () Displays a hierarchical view of the Model presented in execution sequence. Elements are listed in the order defined in solver sequence array. Elements not named there are listed next.
string[] treePath () Constructs a string array which represents a hierarchical view of the model
void updateChildHistories () Updates internal variable and time-dependent histories after the model has converged at the current time-step in child objects
void updateHistory () Updates internal variable and time-dependent histories after the model has converged at the current time-step
void variableChanged (string, any) Shows which option variables have been changed. Is called on the component whenever the value of the variable is set, unless the Option's trigger attribute is FALSE.
int verify () None void warning (string, int) Generates a warning message
void whenDeleted (string) Determines if no message, Warning message, or Error message is sent if the object is deleted
ThermalInputPort has a baseType of ThermalPort.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-57
[ Back to Index ]
4.2.20 ThermalOutputPort
Variables
Variable Description Default Units IO Status
AdiabaticWallTemp Adiabatic wall temperature 0 unset
HeatTransferCoef Heat transfer coefficient 0 unset
HeatTransferRate Heat transfer rate 0 unset
MassTemp Mass temperature ??? unset
areaFlow Flow area 0 unset
areaHx 0 unset
radCurv 0 unset
Functions
Prototype Description void ESOreport (int, string) Informs the errHandler that an error or warning condition has been encountered void VCinit () Contains instructions that will be executed upon instantiation
void addInterface (string) Allows user to add an interface to the object by supplying the desired interface as a single string argument
void copy (string, string) Makes a duplicate of the object specified by the first string and gives it the name specified by the second string
void create (string, string, string) Creates an object of a given baseType and type with the given instance names (all supplied as strings)
void delete (string) Deletes the object supplied as a string void dump (int) dumps names and values of variables void error (string, int) Generates an error message any evalExpr (string) Evaluates an expression int exists (string) Returns TRUE if the object exists in the model, FALSE if it does not string getDataType () Returns the data type of the object any getLinkName () None any getLinkedPortName () None string getName () Returns the object's local name string getParentName () Returns the object's parent's name string getPathName () Returns the object's full pathname string getTextRep (int) Returns ASCII text representation of the object any getVal (string) Returns the contents of the string string[] getVarAttributes () Returns a string containing the attributes of a variable for a specified element int hasInterface (string) Returns TRUE if the single string argument matches an interface the objects supports. If the
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-58
argument does not match, returns FALSE. int hidden () Returns 1 if the object is hidden (won't display in a list), 0 if not hidden
void hide (int) If value=0, object is not hidden. If value=1, object will not display in lists or in AutoDoc output. If value=2, same as value=1 and in addition, upon conversion to C++, the object will not be user accessible at all
void initChildHistories () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations in child objects
void initializeHistory () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations
string isA () Returns the type of the object string isLinkedTo () None
string[] list (string, int) Returns a list of sorted objects; each must match the given type (e.g. 'Element') AND return TRUE for the given expression.
string[] listInterfaces () Returns a string array containing all the interfaces that the object supports void loadCompiledObjects (string, string)
loads pre-compiled objects into the current scope
void message (string) Generates an informational message void move (string, string) Moves object specified by the first string to the location specified by the second string void needVerify () Tells the system that verify() should be run the next time this component is executed void parseEfile (string, string) Processes an encrypted NPSS input file, executing the commands within void parseFile (string) Processes an NPSS input file, executing the commands within void parseString (string) Reads in and executes the given string void provisionalError (string, int) Generates a provisional error message void provisionalWarning (string, int) Generates a provisional warning message
int setOption (string, any) Sets the variable with a given name in and below the scope in which this function is called. When setting the variable's name to a string, the desired value must be in quotes
void setVal (string, any) Assigns the string ref name or attribute, if given
void throwError (string, int) Breaks the flow of execution and generates an error message. If called from interpreted code, execution will resume on the next statement in interpretive code.
void tree () Displays a hierarchical view of the Model presented in execution sequence. Elements are listed in the order defined in solver sequence array. Elements not named there are listed next.
string[] treePath () Constructs a string array which represents a hierarchical view of the model
void updateChildHistories () Updates internal variable and time-dependent histories after the model has converged at the current time-step in child objects
void updateHistory () Updates internal variable and time-dependent histories after the model has converged at the current time-step
void variableChanged (string, any)
Shows which option variables have been changed. Is called on the component whenever the value of the variable is set, unless the Option's trigger attribute is FALSE.
int verify () None void warning (string, int) Generates a warning message void whenDeleted (string) Determines if no message, Warning message, or Error message is sent if the object is deleted
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Port Reference Sheets 4-59
ThermalOutputPort has a baseType of ThermalPort.
[ Back to Index ]
4.2.21 UnReactedFluidPort UnReactedFluidPort has a baseType of Port.
[ Back to Index ]
4.3 Other No data came up for the following ports when running AutoDoc on the Ports.
CTBadd will sum values from up to 3 input ports with up to 2 input constant values.
Variables
Variable Description Default Units IO Status
a_Out constant term added to output sum 0 none input
s_In1 scalar on port In1 value 1 none input
s_In2 scalar on port In2 value 1 none input
s_In3 scalar on port In3 value 1 none input
Functions
Prototype Description
void calculate () None
Ports and Internal Stations
Port/Station Type Description
D_I1 DataInputPort First input signal
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Controls Toolbox Reference Sheets 5-2
D_I2 DataInputPort Second input signal
D_I3 DataInputPort Third input signal
D_O DataOutputPort Exit signal
Usage Notes
- CTBadd is a control toolbox element. - Out = s_In1*In1 + s_In2*In2 + s_In3*In3 + a_Out - An input value may be subtracted by setting it's scalar to -1. - It is not required that all input ports be used.
CTBdrive drives the engine model variable described in an input string to the value entering the input data port. The model variable becomes a solver independent and a solver balance is formed between the model independent and the CTBdrive element's commanded value.
Variables
Variable Description Default Units IO Status
driveVal Value to be driven 0 none output
driveVar String name of commanded variable none input
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
int verify () None
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Controls Toolbox Reference Sheets 5-3
Ports and Internal Stations
Port/Station Type Description
D_I1 DataInputPort Input signal
Independents
Name Description Default Active When
ind_CTBdrive Control commanded variable driveVar Always
Dependents
Name Description eq_lhs eq_rhs Active When
dep_CTBdrive Balance engine and commanded values driveVar D_I1.val Always
Usage Notes
- CTBdrive is a control toolbox element. - driveVar is a required input string. - There is no output port.
CTBif performs logical if tests. Either the signal from node D_I1 or D_I2 is passed to the output, D_O, based on a comparison test between the values of nodes D_I3 and D_I4.
operatorMode if test operator None eq eq, le, ge, gt, lt, ne
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
D_I1 DataInputPort First input signal
D_I2 DataInputPort Second input signal
D_I3 DataInputPort First comparison input signal
D_I4 DataInputPort Second comparison input signal
D_O DataOutputPort Exit signal
Usage Notes
- CTBif is a control toolbox element. - Compare signals entering ports I3 and I4; signal at port I1 is passed to output if comparison is TRUE, signal I2 is passed to output if FALSE. - The signal at one of the comparison ports (I3 or I4) may be compared to 0 if the other comparison port is not linked.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Controls Toolbox Reference Sheets 5-5
- Logic: if ( In3 XX In4 ) Out = In1; else Out = In2; where XX is a logical operator: eq, ge, le, gt, lt, ne input by the string variable operatorMode, default eq. - Use this control element for numerical comparison; use CTBifString for comparison of string inputs.
CTBifString performs logical string if tests. Either the signal from node D_I1 or D_I2 is passed to the output, D_O, based on a comparison test between the string values strng1 and strng2.
Variables
Variable Description Default Units IO Status
strng1 First input string value for comparison none input
strng2 Second input string value for comparison none input
switchDes Determines if the element is in design or offdesign mode
None DESIGN DESIGN, OFFDESIGN
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Controls Toolbox Reference Sheets 5-6
Functions
Prototype Description
void calculate () None
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
D_I1 DataInputPort First input signal
D_I2 DataInputPort Second input signal
D_O DataOutputPort Exit signal
Usage Notes
- CTBifString is a control toolbox element. - Compare input strings strng1 and strng2; signal at port I1 is passed to output if comparison is TRUE, signal I2 is passed to output if comparison is FALSE. - if ( strng1 XX strng2 ) Out = In1; else Out = In2; where XX is a relational operator: eq (default) or ne input by the string variable operatorMode. - Use this control element for string comparison; use CTBif for comparison of numerical inputs.
void variableChanged (string name, any oldVal) None
Ports and Internal Stations
Port/Station Type Description
D_I1 DataInputPort Input signal (derivative)
D_I2 DataInputPort Input initial output signal (IC)
D_O DataOutputPort Exit (integrated) signal
Usage Notes
- CTBintegrate is a control toolbox element. - D_I1 contains the value to be integrated, the difference between the actual and desired values of an engine variable for instance. - D_I2 contains the desired output for steady state (initial condidion). - Integration uses average of current and last time step values of the derivative.
- CTBtable is a control toolbox element. - A table with name TBL must be defined with the element initialization in user's input. - The string variable, tableType, must be set to either 1D or 2D in user's input. - For 1D table, port D_I1 contains the independent x table value and port D_I2 is not linked. y = TBL( x )
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Controls Toolbox Reference Sheets 5-10
- For 2D table, port D_I1 contains the x1 independent and port D_I2 contains the x2 independent table value. y = TBL( x2, x1 )
6.1 Class Index Note: Some infrastructure objects listed below can be found in the Element or Subelement sections (e.g., Element, and VariableContainer). The index links below will take you to them.
Automatically adds correct independent variables and dependent conditions to top-level assembly's solver. If top-level assembly contains assemblies without dedicated solvers, finds necessary independent variables and dependent conditions adds them to top-level assembly's solver.
void linkPorts (string, string, string) Connects a specified port to a second port and labels the station with stationName
void promotePort (string, string) Tells system that an element's port (string) is to be considered a port on a specified assembly (string)
void unlink (string) Breaks a link between two ports; user supplies a string argument corresponding to a station name void unpromotePort (string)
Tells system that a port(string) on a specified assembly (string) is being removed from the assembly and returned from the element from whence it came.
Other Objects
Name Type Description
errHandler MsgHandler
executive Executive
postsolverSequence Alias
presolverSequence Alias
solverSequence Alias
Assembly has a baseType of Element.
[ Back to Index ]
6.3 Element
Variables
Variable Description Default Units IO Status
autoAddToSolvSeq 1 unset
Element has a baseType of ElementBase.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Infrastructure Reference Sheets 6-3
[ Back to Index ]
6.4 ElementBase
Variables
Variable Description Default Units IO Status
version particular version of each component input
Functions
Prototype Description
void clearSolverTerms () Sets the autoSetup flag to FALSE for all objects in the Solver. Objects aren't removed until autoSolverSetup is called.
void execute () Runs a sequence of commands specified by user to execute current Element/Subelement string getExecutive () get the current executive
int getPassType () Identifies the current Model pass as the first pass of a convergence attempt (0), a matrix generation (perturbation) pass (1) or an iteration pass (2)
string[] listSocketTypes () function deprecated void prePass () None void run () Orders Solver to solve Model for a single point with the current input conditions void setExecutive (string) set the current executive void setupExecutive (int) set up the current executive int varNameIsActiveIndep (string)
Determines if the given full variable pathname corresponds to the model variable controlled by any independents in the Solver
int verify () Returns 1 (TRUE) if the Model is valid, 0 (FALSE) if it is not ElementBase has a baseType of VariableContainer.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Infrastructure Reference Sheets 6-4
[ Back to Index ]
6.5 Matrix
Functions
Prototype Description
int Ncols () None
int Nrows () None
real determinant () None
Matrix eigenvalues () None
Matrix eigenvectors () None
int entries () None
string format () None
real[] getCol (int) None
any getMember () None
real[] getRow (int) None
Matrix inverse () None
void setMember () None
real[] toR1D () None
real[][] toR2D () None
Matrix transpose () None
Matrix has a baseType of Variable.
[ Back to Index ]
6.6 MsgHandler
Variables
Variable Description Default Units IO Status
ESIs 8-digit Engineering Status Indicators { } unset errStreamName Controls the stream that the error ESO information is written to errStream unset errors The array of errors contained in the msgHandler { } unset messages The array of messages contained in the msgHandler { } unset msgStreamName The stream that the message() function writes to msgStream unset numCaseErrors The number of case error conditions in the msgHandler 0 unset numCaseWarnings The number of case warning conditions in the msgHandler 0 unset
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Infrastructure Reference Sheets 6-5
numErrors The number of error conditions in the msgHandler 0 unset numMessages The number of messages in the msgHandler 0 unset numProvErrors The number of provisional errors in msgHandler 0 unset numProvWarnings The number of provisional warnings in the MsgHandler 0 unset numWarnings The number of warnings in the msgHandler 0 unset provErrors provisional errors { } unset provWarnings provisional warnings { } unset showProvErrors 0 unset showProvWarnings 0 unset warnStreamName The stream where warning information is written warnStream unset warnings The array of warnings contained in the msgHandler { } unset
Functions
Prototype Description
int ESOexists (int) Returns TRUE (1) if the ESO is found in the errHandler
void clear () Clears all saved conditions (errors/warnings) in errHandler; is NOT automaticall y called by the system
string[] getContexts () Returns list of context strings
string[] getDescriptions () Returns list of the generic descriptions
int[] getESIs () Returns list of ESIs found in the errHandler
int[] getIDs () Returns list of ESOregIDs found in the errHandler
int getNum () Returns number of conditions in errHandler
MsgHandler has a baseType of VariableContainer.
[ Back to Index ]
6.7 Socket
Variables
Variable Description Default Units IO Status
allowedValues { } unset
argTypes { } unset
required 0 unset
returnType unset
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Infrastructure Reference Sheets 6-6
Functions
Prototype Description
int isEmpty ()
Returns TRUE if the user has not instantiated a Subelement to fill the given socket, and returns FALSE if the socket is full.
int verify () Returns TRUE if the model is valid, FALSE if it is not.
Socket has a baseType of VariableContainer.
[ Back to Index ]
6.8 Subelement
Subelement has a baseType of ElementBase.
[ Back to Index ]
6.9 Tokenizer
Variables
Variable Description Default Units IO Status
sourceStr unset
Functions
Prototype Description
string getToken ()
Sequentially parses sourceString based on delim delimiter values. If no parameter is passed into this function, the default delimiters will be used.
Tokenizer has a baseType of VariableContainer.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Infrastructure Reference Sheets 6-7
[ Back to Index ]
6.10 Variable
Functions
Prototype Description
string valType () None
Variable has a baseType of VCInterface.
[ Back to Index ]
6.11 VariableContainer
Functions
Prototype Description
void ESOreport (int, string) Informs the errHandler that an error or warning condition has been encountered
void addInterface (string) Allows user to add an interface to the object by supplying the desired interface as a single string argument
void copy (string, string) Makes a duplicate of the object specified by the first string and gives it the name specified by the second string
void create (string, string, string) Creates an object of a given baseType and type with the given instance names (all supplied as strings)
void delete (string) Deletes the object supplied as a string
void dump (int) dumps names and values of variables
void error (string, int) Generates an error message
any getVal (string) Returns the contents of the string
string[] getVarAttributes () Returns a string containing the attributes of a variable for a specified element
void initChildHistories () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations in child objects
void initializeHistory () Sets the initial values of time-dependent history variables and vectors used to perform internal calculations
string[] list (string, int) Returns a list of sorted objects; each must match the given type (e.g. 'Element') AND return TRUE for the given expression.
void loadCompiledObjects (string, string)
loads pre-compiled objects into the current scope
void message (string) Generates an informational message
void move (string, string) Moves object specified by the first string to the location specified by the second string
void needVerify () Tells the system that verify() should be run the next time this component is executed
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Infrastructure Reference Sheets 6-8
void parseEfile (string, string) Processes an encrypted NPSS input file, executing the commands within
void parseFile (string) Processes an NPSS input file, executing the commands within
void parseString (string) Reads in and executes the given string
void provisionalError (string, int) Generates a provisional error message
void provisionalWarning (string, int)
Generates a provisional warning message
void restore () Restores the value of all variables contained in the object and all objects below it that were saved in the binary file
void save () Saves the current Model state and creates a file containing the saved binary representation of all variables in the object and all objects below it
int setOption (string, any) Sets the variable with a given name in and below the scope in which this function is called. When setting the variable's name to a string, the desired value must be in quotes
void setVal (string, any) Assigns the string ref name or attribute, if given
void throwError (string, int) Breaks the flow of execution and generates an error message. If called from interpreted code, execution will resume on the next statement in interpretive code.
void tree () Displays a hierarchical view of the Model presented in execution sequence. Elements are listed in the order defined in solver sequence array. Elements not named there are listed next.
string[] treePath () Constructs a string array which represents a hierarchical view of the model
void updateChildHistories () Updates internal variable and time-dependent histories after the model has converged at the current time-step in child objects
void updateHistory () Updates internal variable and time-dependent histories after the model has converged at the current time-step
void variableChanged (string, any) Shows which option variables have been changed. Is called on the component whenever the value of the variable is set, unless the Option's trigger attribute is FALSE.
void warning (string, int) Generates a warning message
VariableContainer has a baseType of VariableOnlyContainer.
[ Back to Index ]
6.12 VariableOnlyContainer VariableOnlyContainer has a baseType of VCInterface.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Infrastructure Reference Sheets 6-9
[ Back to Index ]
6.13 VCInterface
Functions
Prototype Description
void VCinit () Contains instructions that will be executed upon instantiation
int exists (string) Returns TRUE if the object exists in the model, FALSE if it does not
string getDataType () Returns the data type of the object
string getName () Returns the object's local name
string getPathName () Returns the object's full pathname
string getTextRep (int) Returns ASCII text representation of the object
int hasInterface (string)
Returns TRUE if the single string argument matches an interface the objects supports. If the argument does not match, returns FALSE.
int hidden () Returns 1 if the object is hidden (won't display in a list), 0 if not hidden
void hide (int) If value=0, object is not hidden. If value=1, object will not display in lists or in AutoDoc output. If value=2, same as value=1 and in addition, upon conversion to C++, the object will not be user accessible at all
string isA () Returns the type of the object
string[] listInterfaces ()
Returns a string array containing all the interfaces that the object supports
void whenDeleted (string)
Determines if no message, Warning message, or Error message is sent if the object is deleted
browserCmd command used to run the browser netscape
unset
doIndex if TRUE, display an index page at the top of html output 0 unset
doPageBreak if TRUE, insert page breaks between each component page 0 unset
doTitlePage if TRUE, display a title page at the top of html output 0 unset
merge if TRUE, writes all html output to a single file. If FALSE, each component will be written to <compname>.html and the index will be found in Index.html
1 unset
noColor if TRUE, generate html for black and white output 0 unset
outDir output directory for generated html files unset
outFile name of the generated html file, if merge==TRUE. If outFile=="cout", html will be written to standard output
unset
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Solver Reference Sheets 7-2
showInheritance if TRUE, displays separate pages for all ancestors of a given class 1 unset
showPrivate if TRUE, displays private variables in html output 0 unset
verbose if TRUE, writes progress information to standard err 0 unset
Functions
Prototype Description
string blockDGen (string) Returns a string containing an ASCII diagram of the given Element or Subelement
void createIndexCategory (string, string[])
Associates a category in the index with a list of class names
string[] listKnownTypes (string) returns a list of all known VCInterface types
string viewClass (string) Generates an html page for the given class
string viewClassList (string[]) Generates an html page for the given list of classes. Takes any number of args that can be combinations of strings and string[]s
string viewInstance (string) Generates an html page for the given instance
Usage Notes
This class generates html pages for individual classes or lists of classes. These pages contain information about the class which includes a list of its variables and their descriptions, a list of its functions, and a list of other objects that reside in the class. The html output can be sent to a file, to standard output, or displayed immediately in a web browser.
AutoDocViewer has a baseType of DataViewer.
[ Back to Index ]
7.3 BinaryViewer
Variables
Variable Description Default Units IO Status
variableList { } unset
Functions
Prototype Description
void display () Prints or displays viewer's data
void reset () Returns viewer options to default values
void update () Retrieves data from the model in its current state
DSVPath History of state values during current model convergence { } none output
allowedValues User-specified list of state values { } none input
autoSetup Add this DSV to Solver setup if TRUE 0 none input
bounce Flags a locked DSV about to return to a value since the DSV was locked 0 none output
changedState TRUE if converged state is different than stateInitial 0 none output
controlBounce Controls if action should be taken when a bounce condition is found 0 none input
level Sets loop level at which the DSV is converged. Lowest level DSVs solved in inner-most loop
0 none input
lockFlag TRUE if DSV free toggled maxFreeToggles number of times 0 none output
lockMaxFreeToggles If TRUE use the value set by the user for this DSV, else use the defaultMaxFreeToggles value in the solver. Manually to FALSE to return to using the Solver default.
0 none input
maxFreeToggles The number of times the state value will be changed while converging continuous model before DSV is lockedand converged in an outer DSV-only iteration loop
0 none input
numFreeToggles Number of times DSV free toggled during current convergence attempt 0 none output
sequential If TRUE, state value only allowed to move one index value towards the index of the demand value
0 none input
state The DSV state value. Controlled by the Solver. Set to stateDemand at end of each DSV iteration loop during the convergence process
none output
stateDemand The desire value of the state set by user or user-code that the state value will be set to or moved towards
none input
stateInitial Initial state value either set by the user or state value from the previously converged point
none output
toggled TRUE if state set to stateDemand during convergence iteration 0 none output
hostCount Number of hosts to spread cpuCount processes across 0 input
inputs Input files to be copied to job { } input
jobDirectory If non-null, the directory for job execution input
jobName Name for queued job input
maxMemory Maximum memory required (MB) 0 input
maxTime Maximum time required 0 min input
outputs Output files to be copied from job { } input
project Name of project (for accounting, etc.) input
queue Name of queue to submit to input
shell Shell to interpret commands /bin/sh input
stdInputs Input files for stdCommands to be copied to job { } input
stdOutputs Output files for stdCommands to be copied from job { } input
Functions
Prototype Description
void use (string jobExecName) Use the specified BatchJobExec subelement to execute the job
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-3
Sockets
Socket Description socketType Sets Values
S_jobExec Fill with a BatchJobExec to perform batch job submission BatchJobExec
BatchJob has a baseType of WrapperBase.
[ Back to Index ]
9.2.2 SimpleWrapper
Simple indirect wrapper for external programs
Functions
Prototype Description void calculate () Run the command line(s) SimpleWrapper has a baseType of WrapperBase.
[ Back to Index ]
9.2.3 WrapperBase Base class for indirect wrappers
Variables
Variable Description Default Units IO Status
calculateStatus Returned status code from command(s) 0 output directory Directory to run in input logicals List of variables created by createLogical() { } unset postexecCommands Commands to execute after stdCommands { } input preexecCommands Commands to execute before stdCommands { } input stdCommands Standard set of commands to be run { } input stderr File for error output, if 'stdout' merge with that stdout input stdin File for standard input input stdout File for standard output input traceLevel Function trace level, 0:off 0 input
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-4
Functions
Prototype Description void createPlotTable (string name, string xArray1D, string yArray1D) Create table for plot void fileReplace (string filename, string str1, string str2) Replace all instances of str1 with str2 in given file WrapperBase has a baseType of Element.
[ Back to Index ]
9.3 External Subelements
9.3.1 BatchJobExec Base class for batch job submitters
Variables
Variable Description Default Units IO Status
useRelativePath Use relative path for execution 1 input
Functions
Prototype Description
void fatalError (string msg) Report a fatal error - this will not return
void generateScript (string scriptName, int needDirectory) Generate 'generic' part of script
void stageInputs () Stage input files if necessary
void stageOutputs (string tmp) Stage output files if necessary
string this () Return the name of this BatchJobExec
Other Objects
Name Type Description
batchJobOut LocalOutFileStream Stream used for writing the batch job script
BatchJobExec has a baseType of Subelement.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-5
[ Back to Index ]
9.3.2 GlobusJobExec A BatchJobExec that runs Globus jobs
Variables
Variable Description Default Units IO Status
cleanRemoteEnvironment Remove the remote directory if created by 'forceRemoteDir'
0 input
debugGRAM Displays GRAM job manager log 0 input
dryrun Submit, but do not execute, this job 0 input
execDir Remote directory for execution input
forceRemoteDir Force creation of a remote directory 0 input
fullRemoteCopy Copy remote dir to local destination 0 input
jobType Type of job that Globus is submitting None single single, multiple
Functions
Prototype Description
void calculate () Create job script, submit it, and then wait for completion
GlobusJobExec has a baseType of BatchJobExec.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-6
[ Back to Index ]
9.3.3 LSFJobExec A BatchJobExec that runs LSF jobs
Variables
Variable Description Default Units IO Status
bsubArgs Arguments passed to bsub input
Functions
Prototype Description
void calculate () Create job script, submit it, and then wait for completion
LSFJobExec has a baseType of BatchJobExec.
[ Back to Index ]
9.3.4 PBSJobExec A BatchJobExec that runs PBS jobs
Variables
Variable Description Default Units IO Status
pollInterval Job status polling interval 5 sec input qsubArgs Arguments passed to qsub input
Functions
Prototype Description void calculate () Create job script, submit it, and then wait for completion PBSJobExec has a baseType of BatchJobExec.
[ Back to Index ]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-7
9.3.5 RemoteJobExec
A BatchJobExec that runs jobs on a remote system
Variables
Variable Description Default Units IO Status
cleanRemoteEnvironment Remove the remote directory if created by 'forceRemoteDir' 0 input execDir Remote directory for execution input forceRemoteDir Force creation of a remote directory 0 input fullRemoteCopy Copy remote dir to local destination 0 input host Name of the remote host input user User ID on remote host input
Functions
Prototype Description void calculate () Create job script, submit it, and then wait for completion RemoteJobExec has a baseType of BatchJobExec.
[ Back to Index ]
9.3.6 ShellJobExec A BatchJobExec that runs the commands directly within a sub-shell
Variables
Variable Description Default Units IO Status
directOutput Output directly to stdout rather than holding in a temporary file 0 input
Functions
Prototype Description void calculate () Create job script, submit it, and then wait for completion ShellJobExec has a baseType of BatchJobExec.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-8
[ Back to Index ]
9.4 External Containers
9.4.1 ConcurrentExec Concurrent model execution engine
Variables
Variable Description Default Units IO Status
IDLE Server is currently idle 0 const LOADING Server is loading its model 1 const STARTED Server has started a calculation 2 const UNUSED Server is not being used 3 const factories Names of ConcurrentFactories found by initial run() { } output reuseServers Flag indicating if servers and their loaded model can be re-used or not 0 input serverStates State of server at corresponding index in servers array { } output servers Names of servers, they are created from factories { } output synchronous If non-zero, servers run in lock-step, maintaining evaluation order 1 input traceLevel Server activity tracing level, 0 => off 0 input useInternalServer Use an in-process Assembly, not ConcurrentFactory servers 0 input
Functions
Prototype Description void run () Run calculations on servers concurrently ConcurrentExec has a baseType of VariableContainer.
[ Back to Index ]
9.4.2 ConcurrentFactory Specialized ServerSpec used with ConcurrentExec
Variables
Variable Description Default Units IO Status
nServers Number of concurrent servers to start using this factory 1 input ConcurrentFactory has a baseType of ServerSpec.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-9
[ Back to Index ]
9.4.3 MapGenerator Generate a map based on data obtained by running model
Variables
Variable Description Default Units IO Status
assembly If non-null, the name of the assembly to run unset
avgTime Average time for model run 0 sec unset
comments Strings to write at top of map file { } unset
filename Name of file to write map to unset
independents Names of MGindependent objects { } unset
nRuns # of model runs 0 unset
tables Names of MGtable objects { } unset
totalTime Total time for model runs 0 sec unset
validRunPtr If non-null, the name of a variable which is set TRUE if the run has valid results
unset
Functions
Prototype Description
void addIndependent (string name) None
void addTable (string name) None
void removeIndependent (string name) None
void removeTable (string name) None
void run () Run assembly at each combination of independent values and write out table definitions
MapGenerator has a baseType of VariableContainer.
[ Back to Index ]
9.4.4 MGdependent Definition of dependent variable for MapGenerator
Variables
Variable Description Default Units IO Status
values { } unset
variable unset
MGdependent has a baseType of VariableContainer.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-10
[ Back to Index ]
9.4.5 MGindependent Definition of independent variable for MapGenerator
void clear () Clear data for new map generation run
void removeIndependent (string name) None
void update (int validRun) Grab dependent and calculated independent values
int verify () None
int write (string stream) Write table definition to given stream
MGtable has a baseType of VariableContainer.
[ Back to Index ]
9.4.7 Namelist
Variables
Variable Description Default Units IO Status nmlDynamic If non-zero, unknown variables are created during read(). 1 input nmlGroup If not null, name of namelist group. Default is instance name. input nmlLogicals Variables of type LOGICAL. { } unset nmlTerminator String used to terminate the namelist. Some older Fortran
implementations want '&END'. / input
nmlTrace If non-zero, print debugging information during read(). 0 input nmlVars Names of variables. { } unset nmlWriteDefaults If non-zero, unchanged default values are written. 0 input nmlWriteElements If non-zero, 2D and 3D arrays are written one element per line.
Necessary on at least one incarnation of HP Fortran. 0 input
Functions
Prototype Description void clear () Clear variable definitions & values int read (string stream) Read namelist matching our group or instance name void setDefaults () None int write (string stream) Write namelist for our group or instance name
Other Objects
Name Type Description nmlDefaults VariableContainer Predefined namelist variables and default values. Namelist has a baseType of VariableContainer.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-12
[ Back to Index ]
9.4.8 ProxySpec Specification for an NPSS proxy used by sys.startServer()
Variables
Variable Description Default Units IO Status
bound TRUE if proxy has been bound to local NamingService 0 output
context Local NamingService context name to bind to input
host Proxy host name input
iorFile IOR filename on host input
Functions
Prototype Description
void VCinit () None
int bind (string user) Grab remote proxy IOR file and bind to name in local Name Service
string this () Return name of this ProxySpec
void unbind () Delete the proxy context we've bound in the local Name Service
ProxySpec has a baseType of VariableContainer.
[ Back to Index ]
9.4.9 ServerSpec Specification for a server used by sys.startServer()
Variables
Variable Description Default Units IO Status
arguments Arguments for the command input
bind Force binding in local NamingService 0 input
command Command to run input
context NamingService context to use input
directory Directory to run server in input
domain CORBASec security domain name input
factory TRUE if this server is a factory 0 input
foreign TRUE if this is a ForeignElement server 0 input
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-13
fullCmd Full command for launched server output
host Server host name (null implies local host) input
ior IOR filename output
outFile Output filename output
parentContext NamingService context of 'parent' output
pid Process ID of server -1 output
port Port to be used (<=0 => system selected) 0 input
timeout Time to wait for server to start 120 sec input
hostOS Server host operating system type None Unknown Unknown, UNIX, Windows
state State of the server None DOWN DOWN, LAUNCHED, READY
Functions
Prototype Description
void VCinit () None
int kill () Kill this server
int launch () Launch this server
int start () Start this server
string this () Return the name of this ServerSpec
int up () Check if server is up
ServerSpec has a baseType of VariableContainer.
[ Back to Index ]
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
Revision page 9-15
Revision Page
Rev Date Description of Change – 07/15/97 Initial release of User and Reference Guides
See the revision page in the User Guide and Reference for changes for REVs A-L. The reference sheets were part of the
that document until 10/30/00, when they were removed. M 11/15/00 Changes incorporated into NPSS_1.2.0: CR1040 (wet/dry parameters added to GasTbl flow station,) CR1024
(superOrSub added to thermo ref sheets, 1.1, 1.3, 1.5) [10/3] [10/10] new ref sheets per CR898 [10/19] CR747 (socket redesign, removed socketType attribute from all subelement ref sheets, chapter 3) [10/31] CR1043 (variable AphyDes added to Therm, GasTble, Janaf ref sheets, 1.1, 1.3. 1.5) [11/14]
N 06/13/01 Changes incorporated into NPSS_1.3.0: CR988 (HeatTransfer changed to ThermalMass, 3.27)[1/10/01] CR1086 (FlowDuplicator1_2 changed to FlowDuplicator) [2/5]. CR1084 (Nozzle updates, 2.2.1) [6/1/01] CR1115 (HeatExchanger Ref Sheet, 2.15) [6/11/01] Moved tables from User Guide to Ref sheets [6/28/01]
O 09/27/01 Changes incorporated into NPSS_1.4.0: CR1011 (new Mixer1 Ref Sheet, 2.21) CR1101 (new Nozzle Ref sheet, 2.22) CR1177 (New variables added to Flow/Fuel Stations 1.0) [7/3/01] CR1180 (2 new elements: BleedOut & BleedOutInterstage, 2.2, 2.3) [7/9] CR1278 Updated flowstations and fuelstations for I/O status; variable descriptions updated, 1.1-1.6 [7/13] CR1349 (remove reference to E-Specs) [8/1] CR1183 (Update Compressor & several subelements/maps) CR1300 (update Duct, InstrumentDuct, FuelStart) CR1288 (Block Diagram Generator) CR1257 (AutoDoc enhancements), Updated Thermos Ref sheets; added Port ref sheets. [9/7] CR1336 (New element: Ambient, 2.1)[9/21] CR1352 (Updated shaft ref sheet)[9/24] Fix markings for increment, copyright [9/26]
P 3/20/02 Changes incorporated into NPSS_1.5.0: CR1422 (Updates to Ambient, 2.1) [10/11/01] CR1160 (New controls toolbox elements, new Chapter 3) [10/17/01] Fixed typo in Compressor notes: Sh_O.Inertia []10/25] CR1432 (fixed _tstdtab in Ambient, 2.4) [10/30] CR1433 (removed EngPerf) [11/19] CR1434 (changed units in Ambient and flow stations) [11/30] CR1443 (updated variable in InterStageBleedInPort, 5.90 [12/19] CR1459 (Controls TB updates; new element CTBifString, 3.0) CR1381 (Slinger element, 2.29) [3/4/02] CR1435 (CEA flow and fuel stations—new 1.7, 1.8) [3/12] CR1418 (Janaf Ref sheets, deleted some variables) Markings for 1.5.0 [3/20/02]
Q 5/13/03 Changes (CRs) incorporated into NPSS_1.5.1: CR1511 (Removed list of functions from port ref sheets as some functions incorrect.) [4/12/02, 150B] Moved Controls Ref sheets after Ports—no text changes.[6/5/02] CR1543 (GasTbl updates, GasTblFlowStation, sec. 1.5, updated) [8/13/02, 150T] CR694 (With implementation of the NT Port, thermo package “Therm” was deleted; removed “Therm” ref sheets, Chapter 1.) [9/26/02, 150W] CR1576 (updated FuelStart, FlowStart) CR1580 (updated CEAFlowStation) [10/29, 150Z] CRs1444 (new: Instrument1), CR1214 (new: EngPerf ), CR1465 (update Ambient, new: TDay subelement) [11/1, 150AA] CR1462A (allFuel added, flow station redesignl thermo sheets updated; ComperssorMap and TurbineNeppMap updated; clarified “Dissociated.” [1/27/03, 150AI] CR1675 (updated thermo ref sheets, and Ambient, Burner, FlowStart, and FuelStart.) [2/28/03, 150AM] CR1720 (allFuel ref sheets updated) CR1692 (CEA updates—new option variable for thermos) CR1508 (added function descriptions for infrastructure and dataviewers) [RE150AS, 4/9/03] CR1706 (new FuelSplitter Element, updated Burner) [4/22/03] CR1599 (CEAFlowStations, new variables, 1.3) [250 AW, 4/29] CR1759 (added more missing descriptions) [5/13/03, 150 AZ]
R 9/26/03 Changes (CRs) incorporated into NPSS_1.6.0: CR1700 (new variable, hcratio, added to thermo ref sheets) [6/11/03, 151A] CR1789 (Updated CEA ref sheets)[1.5.1C], CR1652 (updated Ambient, TDay, ramRecovery, Inlet; added new FlightEnvelope)[151D] CR1691 (removed obsolete elements and subelements) and corrected preface. [151E, 7/16/03] CR1895 (update Compressor option variables and update other option variables, sockets)[9/8/03, REV: N] CR1367 (changed name to reference sheets) [9/23/03 REV:P] changed cover page and header for 1.6.0 release 9/23/03
S 5/21/04 Changes (CRs) incorporated into NPSS_1.6.1: CR1749 (updated thermo ref sheets) [10-20-03, REV: B] CR1884 (new INGTherm ref sheets added) [11-17-03, REV: F] CR1493 (dhoT unit change in turbine); CR1941 (corrected unit on NcDes in CompressorMap) [12/22/03, REV: L] CR1124, CR1126, CR1284 & CR1830 (updated element and subelement ref sheets for variable name changes, new thermo ref sheets generated also) [4.2/04, REV: AG] CR1973 (updates to VariableContainer Ref Sheet) [w/Rev: Q] and CR1728 (update () added to BleedOutPort and InterstageBleedOutPort) [5/10, REV: AN]
T 9/30/04 Changes (CRs) incorporated into NPSS_1.6.2: CR2031 (update variables in allFuel, Janaf, and GstTbl FlowStation Ref sheets) [REV: 1.6.1A, 6/2/04] CR2097 (new AutoDoc with index, links—updatd Ref sheets) Note: CR2097 not implemented yet but new sheets were part of CR2053 (converted AutoDoc to C++ code) that was implemented. [8/4] CR1920 (new setLHV() function added to fuel station) [8/12/04, REV: N] [CR2088 (new flowstation variables added) [Rev: S, 8/30] CR2123 (updated mixer) [Rev: Y, 9/28]
V 5/30/06 Changes (CRs) incorporated into NPSS_1.6.4: CR1046 (attributre added to Element, 2.36)[Rev: C, 5/27/05]; CR1405 (new function: void whenDeleted (string), 2.40 )[6/2, Rev: F] CR2267 (added Pration & Tratio, 1.13) [Rev; U, 11/8/05] CR2311 (added ref sheets for external elements, subelements; contains, Chapter 9) [Rev: 1.6.3 AL 3/23/06]; CR2318 (Added TransExec and TransientExecutive to Solver ref sheets) [REV:AN, 4/19/06] Markings updated for 5/30/06 release.
Doc. #: NPSS–Ref Sheets REV: 1.6.5 Date: 3/12/08
External Components 9-16
W in progress
Changes (CRs) that will be incorporated into NPSS_1.6.5: CR2339 (updates to GasTble Ref sheets ); CR2340 (updates to CEA ref sheets) [Rev: G, 8/7/06]. CR2286 (updated reference sheets for ARP compliant components) [Rev: J: 8/28/06 and 9/8/06] CR2355 (more ARP compliant components; change names of NASA elements—move NASA to end of name instead of beginning) [Rev: N, 10/20/06] CR2373 (access variables added to CEA Flowstation) [12/15/06, Rev: R] CR2377 (update several NASA components and turbine for ARP compliance) [12/22/06, Rev T] CR2361 (updated flowstations for flow parameter) [1/5/07, Rev: U] CR2381 (updated heat exchanger for pressure drop calcs) [1/5/07, Rev: V] Note: Updated Container reference sheets when did HiFi Reference sheets in Jan. 2008, but did not check in until updating for CR2441.