Configuration options for the simulation. More...
#include <readConfig.h>
Public Member Functions | |
| ConfigOptions () | |
| bool | debugIntegratorStages (double t) const |
| Returns true if integrator stage data should be saved at the current time step. | |
| void | setContinuityBC (const std::string &condition) |
| Set the value of continuityBC by name. | |
Public Attributes | |
| std::string | outputDir |
| [paths.outputDir] | |
| bool | fixedBurnedVal |
| [general.fixedBurnedVal] True if burned gas state is fixed at equilibrium conditions. | |
| bool | fixedLeftLoc |
| [general.fixedLeftLocation] True if the position of the leftmost grid point is fixed. | |
| bool | twinFlame |
| [general.twinFlame] Set to true for the twin flame configuration. | |
| bool | discFlame |
| [general.discFlame] Set to true for the axisymmetric jet flame configuration. | |
| ContinuityBoundaryCondition::BC | continuityBC |
| bool | cylindricalFlame |
| [general.cylindricalFlame] Set to true for the cylindrical flame configuration. | |
| bool | unburnedLeft |
| [general.unburnedLeft] | |
| bool | fuelLeft |
| [general.fuelLeft] | |
| std::string | flameType |
| [initialCondition.flameType] | |
| int | regridStepInterval |
| [times.regridStepInterval] | |
| int | outputStepInterval |
| [times.outputStepInterval] | |
| int | profileStepInterval |
| [times.profileStepInterval] | |
| int | currentStateStepInterval |
| [times.currentStateStepInterval] | |
| int | terminateStepInterval |
| [times.terminateStepInterval] | |
| double | regridTimeInterval |
| [times.regridTimeInterval] | |
| double | outputTimeInterval |
| [times.outputTimeInterval] | |
| double | profileTimeInterval |
| [times.profileTimeInterval] | |
| double | globalTimestep |
| [times.globalTimestep] | |
| double | diffusionTimestepMultiplier |
| [times.diffusionTimestepMultiplier] | |
| std::string | splittingMethod |
| [general.splittingMethod] | |
| std::string | chemistryIntegrator |
| [general.chemistryIntegrator] | |
| double | integratorRelTol |
| [cvodeTolerances.relativeTolerance] | |
| double | integratorMomentumAbsTol |
| [cvodeTolerances.momentumAbsTol] | |
| double | integratorEnergyAbsTol |
| [cvodeTolerances.energyAbsTol] | |
| double | integratorSpeciesAbsTol |
| [cvodeTolerances.speciesAbsTol] | |
| double | integratorMinTimestep |
| [cvodeTolerances.minimumTimestep] | |
| double | qss_epsmax |
| [qssTolerances.epsmax] | |
| double | qss_epsmin |
| [qssTolerances.epsmin] | |
| double | qss_dtmin |
| [qssTolerances.dtmin] | |
| double | qss_dtmax |
| [qssTolerances.dtmax] | |
| int | qss_iterationCount |
| [qssTolerances.iterationCount] | |
| double | qss_abstol |
| [qssTolerances.abstol] | |
| double | qss_minval |
| [qssTolerances.minval] | |
| bool | qss_stabilityCheck |
| [qssTolerances.stabilityCheck] | |
| std::string | gasMechanismFile |
| [chemistry.mechanismFile] | |
| std::string | gasPhaseID |
| [chemistry.phaseID] | |
| std::string | kineticsModel |
| [chemistry.kineticsModel] | |
| std::string | transportModel |
| [chemistry.transportModel] | |
| double | transportThreshold |
| [chemistry.threshold] | |
| std::string | rateMultiplierFunctionType |
| [see chemistry.rateMultiplierFunction] | |
| double | pressure |
| [initialConditoin.pressure] | |
| std::string | strainFunctionType |
| double | strainRateInitial |
| [strainParameters.initial] | |
| double | strainRateFinal |
| [strainParameters.final] | |
| double | strainRateDt |
| [strainParameters.dt] | |
| double | strainRateT0 |
| [strainParameters.tStart] | |
| dvec | x_initial |
| [initialCondition.x] | |
| dvec | T_initial |
| [initialCondition.T] | |
| dvec | U_initial |
| [initialCondition.U] | |
| dvec | V_initial |
| [initialCondition.V] | |
| dmatrix | Y_initial |
| [initialCondition.Y] | |
| bool | quasi2d |
| If false, energy, continuity, and momentum equations are integrated normally. | |
| std::string | interpFile |
| Data file containing 2D interpolation data [general.interpFile]. | |
| bool | wallFlux |
| double | Tinf |
| double | Kwall |
| double | ignition_tStart |
| [ignition.tStart] | |
| double | ignition_duration |
| [ignition.duration] | |
| double | ignition_energy |
| [ignition.energy] | |
| double | ignition_center |
| [ignition.center] | |
| double | ignition_stddev |
| [ignition.stddev] | |
| bool | alwaysUpdateHeatFlux |
| [externalHeatFlux.alwaysUpdate] | |
| double | vtol |
| [grid.vtol] | |
| double | dvtol |
| [grid.dvtol] | |
| double | rmTol |
| [grid.rmTol] | |
| double | dampConst |
| [grid.dampConst] | |
| double | gridMin |
| [grid.gridMin] | |
| double | gridMax |
| [grid.gridMax] | |
| double | uniformityTol |
| [grid.uniformityTol] | |
| double | absvtol |
| [grid.absvtol] | |
| double | boundaryTol |
| [grid.boundaryTol] | |
| double | boundaryTolRm |
| [grid.boundaryTolRm] | |
| double | unstrainedDownstreamWidth |
| [grid.unstrainedDownstreamWidth] | |
| int | addPointCount |
| [grid.addPointCount] | |
| double | tStart |
| [times.tStart] | |
| double | tEnd |
| [terminationCondition.tEnd] | |
| double | tEndMin |
| [terminationCondition.tMin] | |
| bool | haveTStart |
| bool | outputProfiles |
| [outputFiles.saveProfiles] | |
| int | debugSourcePoint |
| Grid point index marked for verbose output (cvodeSteps.py) [debug.sourcePoint]. | |
| double | debugSourceTime |
| Integrator time at which to generate verbose output (then terminate) [debug.sourceTime]. | |
| double | debugStartTime |
| Integrator time at which to begin saving output between integrator stages [debug.startTime]. | |
| double | debugStopTime |
| Integrator time at which to stop saving output between integrator stages [debug.stopTime]. | |
| bool | outputDebugIntegratorStages |
| [outputFiles.debugIntegratorStages] | |
| std::string | terminationMeasurement |
| If non-empty, code finishes when the specified property is constant to within some tolerance [terminationCondition.measurement]. | |
| double | terminationTolerance |
| relative tolerance for termination [terminationCondition.tolerance] | |
| double | terminationAbsTol |
| absolute tolerance for termination using measurement == 'Q' [terminationCondition.abstol] | |
| double | termination_dTdtTol |
tolerance for termination when measurement == dTdt [terminationCondition.dTdtTol] | |
| double | terminationPeriod |
| period over which to require constant heat release rate [terminationCondition.steadyPeriod] | |
| int | errorStopCount |
| [general.errorStopCount] | |
| bool | stopIfError |
| int | nThreads |
| [general.nThreads] | |
| double | centerGridMin |
| [grid.centerGridMin] | |
| bool | xFlameControl |
| double | xFlameInitial |
| [positionControl.xInitial] | |
| double | xFlameFinal |
| [positionControl.xFinal] | |
| double | xFlameDt |
| [positionControl.dt] | |
| double | xFlameT0 |
| [positionControl.tStart] | |
| double | xFlameIntegralGain |
| [positionControl.integralGain] | |
| double | xFlameProportionalGain |
| [positionControl.proportionalGain] | |
| bool | xStagControl |
| double | xStag |
Detailed Description
Configuration options for the simulation.
These are more fully documented in input.py. For variables that correspond to a definition in input.py, the name used for the variable in that file is given in square brackets.
Constructor & Destructor Documentation
◆ ConfigOptions()
|
inline |
Member Function Documentation
◆ debugIntegratorStages()
| bool ConfigOptions::debugIntegratorStages | ( | double | t | ) | const |
Returns true if integrator stage data should be saved at the current time step.
◆ setContinuityBC()
| void ConfigOptions::setContinuityBC | ( | const std::string & | condition | ) |
Set the value of continuityBC by name.
Member Data Documentation
◆ outputDir
| std::string ConfigOptions::outputDir |
[paths.outputDir]
◆ fixedBurnedVal
| bool ConfigOptions::fixedBurnedVal |
[general.fixedBurnedVal] True if burned gas state is fixed at equilibrium conditions.
◆ fixedLeftLoc
| bool ConfigOptions::fixedLeftLoc |
[general.fixedLeftLocation] True if the position of the leftmost grid point is fixed.
◆ twinFlame
| bool ConfigOptions::twinFlame |
[general.twinFlame] Set to true for the twin flame configuration.
If specified, the leftmost grid point will not extend beyond x = 0.
◆ discFlame
| bool ConfigOptions::discFlame |
[general.discFlame] Set to true for the axisymmetric jet flame configuration.
◆ continuityBC
| ContinuityBoundaryCondition::BC ConfigOptions::continuityBC |
◆ cylindricalFlame
| bool ConfigOptions::cylindricalFlame |
[general.cylindricalFlame] Set to true for the cylindrical flame configuration.
If specified, the leftmost grid point will not extend beyond x = 0.
◆ unburnedLeft
| bool ConfigOptions::unburnedLeft |
[general.unburnedLeft]
◆ fuelLeft
| bool ConfigOptions::fuelLeft |
[general.fuelLeft]
◆ flameType
| std::string ConfigOptions::flameType |
[initialCondition.flameType]
◆ regridStepInterval
| int ConfigOptions::regridStepInterval |
[times.regridStepInterval]
◆ outputStepInterval
| int ConfigOptions::outputStepInterval |
[times.outputStepInterval]
◆ profileStepInterval
| int ConfigOptions::profileStepInterval |
[times.profileStepInterval]
◆ currentStateStepInterval
| int ConfigOptions::currentStateStepInterval |
[times.currentStateStepInterval]
◆ terminateStepInterval
| int ConfigOptions::terminateStepInterval |
[times.terminateStepInterval]
◆ regridTimeInterval
| double ConfigOptions::regridTimeInterval |
[times.regridTimeInterval]
◆ outputTimeInterval
| double ConfigOptions::outputTimeInterval |
[times.outputTimeInterval]
◆ profileTimeInterval
| double ConfigOptions::profileTimeInterval |
[times.profileTimeInterval]
◆ globalTimestep
| double ConfigOptions::globalTimestep |
[times.globalTimestep]
◆ diffusionTimestepMultiplier
| double ConfigOptions::diffusionTimestepMultiplier |
[times.diffusionTimestepMultiplier]
◆ splittingMethod
| std::string ConfigOptions::splittingMethod |
[general.splittingMethod]
◆ chemistryIntegrator
| std::string ConfigOptions::chemistryIntegrator |
[general.chemistryIntegrator]
◆ integratorRelTol
| double ConfigOptions::integratorRelTol |
[cvodeTolerances.relativeTolerance]
◆ integratorMomentumAbsTol
| double ConfigOptions::integratorMomentumAbsTol |
[cvodeTolerances.momentumAbsTol]
◆ integratorEnergyAbsTol
| double ConfigOptions::integratorEnergyAbsTol |
[cvodeTolerances.energyAbsTol]
◆ integratorSpeciesAbsTol
| double ConfigOptions::integratorSpeciesAbsTol |
[cvodeTolerances.speciesAbsTol]
◆ integratorMinTimestep
| double ConfigOptions::integratorMinTimestep |
[cvodeTolerances.minimumTimestep]
◆ qss_epsmax
| double ConfigOptions::qss_epsmax |
[qssTolerances.epsmax]
◆ qss_epsmin
| double ConfigOptions::qss_epsmin |
[qssTolerances.epsmin]
◆ qss_dtmin
| double ConfigOptions::qss_dtmin |
[qssTolerances.dtmin]
◆ qss_dtmax
| double ConfigOptions::qss_dtmax |
[qssTolerances.dtmax]
◆ qss_iterationCount
| int ConfigOptions::qss_iterationCount |
[qssTolerances.iterationCount]
◆ qss_abstol
| double ConfigOptions::qss_abstol |
[qssTolerances.abstol]
◆ qss_minval
| double ConfigOptions::qss_minval |
[qssTolerances.minval]
◆ qss_stabilityCheck
| bool ConfigOptions::qss_stabilityCheck |
[qssTolerances.stabilityCheck]
◆ gasMechanismFile
| std::string ConfigOptions::gasMechanismFile |
[chemistry.mechanismFile]
◆ gasPhaseID
| std::string ConfigOptions::gasPhaseID |
[chemistry.phaseID]
◆ kineticsModel
| std::string ConfigOptions::kineticsModel |
[chemistry.kineticsModel]
◆ transportModel
| std::string ConfigOptions::transportModel |
[chemistry.transportModel]
◆ transportThreshold
| double ConfigOptions::transportThreshold |
[chemistry.threshold]
◆ rateMultiplierFunctionType
| std::string ConfigOptions::rateMultiplierFunctionType |
[see chemistry.rateMultiplierFunction]
◆ pressure
| double ConfigOptions::pressure |
[initialConditoin.pressure]
◆ strainFunctionType
| std::string ConfigOptions::strainFunctionType |
◆ strainRateInitial
| double ConfigOptions::strainRateInitial |
[strainParameters.initial]
◆ strainRateFinal
| double ConfigOptions::strainRateFinal |
[strainParameters.final]
◆ strainRateDt
| double ConfigOptions::strainRateDt |
[strainParameters.dt]
◆ strainRateT0
| double ConfigOptions::strainRateT0 |
[strainParameters.tStart]
◆ x_initial
| dvec ConfigOptions::x_initial |
[initialCondition.x]
◆ T_initial
| dvec ConfigOptions::T_initial |
[initialCondition.T]
◆ U_initial
| dvec ConfigOptions::U_initial |
[initialCondition.U]
◆ V_initial
| dvec ConfigOptions::V_initial |
[initialCondition.V]
◆ Y_initial
| dmatrix ConfigOptions::Y_initial |
[initialCondition.Y]
◆ quasi2d
| bool ConfigOptions::quasi2d |
If false, energy, continuity, and momentum equations are integrated normally.
If true, then time is actually a surrogate for a spatial variable and the temperature and velocity fields are interpolated from a supplied data file.
◆ interpFile
| std::string ConfigOptions::interpFile |
Data file containing 2D interpolation data [general.interpFile].
◆ wallFlux
| bool ConfigOptions::wallFlux |
◆ Tinf
| double ConfigOptions::Tinf |
◆ Kwall
| double ConfigOptions::Kwall |
◆ ignition_tStart
| double ConfigOptions::ignition_tStart |
[ignition.tStart]
◆ ignition_duration
| double ConfigOptions::ignition_duration |
[ignition.duration]
◆ ignition_energy
| double ConfigOptions::ignition_energy |
[ignition.energy]
◆ ignition_center
| double ConfigOptions::ignition_center |
[ignition.center]
◆ ignition_stddev
| double ConfigOptions::ignition_stddev |
[ignition.stddev]
◆ alwaysUpdateHeatFlux
| bool ConfigOptions::alwaysUpdateHeatFlux |
[externalHeatFlux.alwaysUpdate]
◆ vtol
| double ConfigOptions::vtol |
[grid.vtol]
◆ dvtol
| double ConfigOptions::dvtol |
[grid.dvtol]
◆ rmTol
| double ConfigOptions::rmTol |
[grid.rmTol]
◆ dampConst
| double ConfigOptions::dampConst |
[grid.dampConst]
◆ gridMin
| double ConfigOptions::gridMin |
[grid.gridMin]
◆ gridMax
| double ConfigOptions::gridMax |
[grid.gridMax]
◆ uniformityTol
| double ConfigOptions::uniformityTol |
[grid.uniformityTol]
◆ absvtol
| double ConfigOptions::absvtol |
[grid.absvtol]
◆ boundaryTol
| double ConfigOptions::boundaryTol |
[grid.boundaryTol]
◆ boundaryTolRm
| double ConfigOptions::boundaryTolRm |
[grid.boundaryTolRm]
◆ unstrainedDownstreamWidth
| double ConfigOptions::unstrainedDownstreamWidth |
[grid.unstrainedDownstreamWidth]
◆ addPointCount
| int ConfigOptions::addPointCount |
[grid.addPointCount]
◆ tStart
| double ConfigOptions::tStart |
[times.tStart]
◆ tEnd
| double ConfigOptions::tEnd |
[terminationCondition.tEnd]
◆ tEndMin
| double ConfigOptions::tEndMin |
[terminationCondition.tMin]
◆ haveTStart
| bool ConfigOptions::haveTStart |
◆ outputProfiles
| bool ConfigOptions::outputProfiles |
[outputFiles.saveProfiles]
◆ debugSourcePoint
| int ConfigOptions::debugSourcePoint |
Grid point index marked for verbose output (cvodeSteps.py) [debug.sourcePoint].
◆ debugSourceTime
| double ConfigOptions::debugSourceTime |
Integrator time at which to generate verbose output (then terminate) [debug.sourceTime].
◆ debugStartTime
| double ConfigOptions::debugStartTime |
Integrator time at which to begin saving output between integrator stages [debug.startTime].
◆ debugStopTime
| double ConfigOptions::debugStopTime |
Integrator time at which to stop saving output between integrator stages [debug.stopTime].
◆ outputDebugIntegratorStages
| bool ConfigOptions::outputDebugIntegratorStages |
[outputFiles.debugIntegratorStages]
◆ terminationMeasurement
| std::string ConfigOptions::terminationMeasurement |
If non-empty, code finishes when the specified property is constant to within some tolerance [terminationCondition.measurement].
◆ terminationTolerance
| double ConfigOptions::terminationTolerance |
relative tolerance for termination [terminationCondition.tolerance]
◆ terminationAbsTol
| double ConfigOptions::terminationAbsTol |
absolute tolerance for termination using measurement == 'Q' [terminationCondition.abstol]
◆ termination_dTdtTol
| double ConfigOptions::termination_dTdtTol |
tolerance for termination when measurement == dTdt [terminationCondition.dTdtTol]
◆ terminationPeriod
| double ConfigOptions::terminationPeriod |
period over which to require constant heat release rate [terminationCondition.steadyPeriod]
◆ errorStopCount
| int ConfigOptions::errorStopCount |
[general.errorStopCount]
◆ stopIfError
| bool ConfigOptions::stopIfError |
◆ nThreads
| int ConfigOptions::nThreads |
[general.nThreads]
◆ centerGridMin
| double ConfigOptions::centerGridMin |
[grid.centerGridMin]
◆ xFlameControl
| bool ConfigOptions::xFlameControl |
◆ xFlameInitial
| double ConfigOptions::xFlameInitial |
[positionControl.xInitial]
◆ xFlameFinal
| double ConfigOptions::xFlameFinal |
[positionControl.xFinal]
◆ xFlameDt
| double ConfigOptions::xFlameDt |
[positionControl.dt]
◆ xFlameT0
| double ConfigOptions::xFlameT0 |
[positionControl.tStart]
◆ xFlameIntegralGain
| double ConfigOptions::xFlameIntegralGain |
[positionControl.integralGain]
◆ xFlameProportionalGain
| double ConfigOptions::xFlameProportionalGain |
[positionControl.proportionalGain]
◆ xStagControl
| bool ConfigOptions::xStagControl |
◆ xStag
| double ConfigOptions::xStag |
The documentation for this class was generated from the following files:
- src/readConfig.h
- src/readConfig.cpp
Generated on Mon Sep 15 2025 22:28:18 for Ember by
1.13.2