CG  Version 25
Public Types | Public Member Functions | List of all members
CnsParameters Class Reference

This class holds parameters for Cgcns. More...

#include <CnsParameters.h>

Inheritance diagram for CnsParameters:
Inheritance graph
[legend]
Collaboration diagram for CnsParameters:
Collaboration graph
[legend]

Public Types

enum  BoundaryConditions {
  inflowWithVelocityGiven =2, outflow =5, superSonicInflow =6, superSonicOutflow =7,
  subSonicInflow =8, subSonicOutflow =10, convectiveOutflow =14, tractionFree =15,
  farField =16
}
 
enum  PDE { compressibleNavierStokes =2, compressibleMultiphase =5 }
 
enum  GodunovVariation {
  fortranVersion, cppVersionI, cppVersionII, multiComponentVersion,
  multiFluidVersion
}
 
enum  EquationOfStateEnum {
  idealGasEOS =0, jwlEOS =1, mieGruneisenEOS =2, userDefinedEOS =3,
  stiffenedGasEOS =4, taitEOS =5
}
 
enum  RiemannSolverEnum { exactRiemannSolver =0, roeRiemannSolver =1, futureRiemannSolver =2, hLLRiemannSolver =3 }
 
enum  PDEVariation { nonConservative =0, conservativeWithArtificialDissipation =1, conservativeGodunov =2 }
 
enum  TestProblems { standard, laminarFlame }
 
- Public Types inherited from Parameters
enum  ForcingType { noForcing = 0, showfileForcing, numberOfForcingTypes }
 
enum  Stuff { defaultValue =-12345678, maximumNumberOfOutputFiles =10 }
 
enum  TurbulenceModel {
  noTurbulenceModel =0, BaldwinLomax =1, kEpsilon =2, kOmega =3,
  SpalartAllmaras =4, LargeEddySimulation =5, numberOfTurbulenceModels
}
 
enum  TimeSteppingMethod {
  forwardEuler, adamsBashforth2, adamsPredictorCorrector2, adamsPredictorCorrector4,
  variableTimeStepAdamsPredictorCorrector, laxFriedrichs, implicit, rKutta,
  midPoint, implicitAllSpeed, implicitAllSpeed2, nonMethodOfLines,
  steadyStateRungeKutta, steadyStateNewton, secondOrderSystemTimeStepping, adi,
  numberOfTimeSteppingMethods
}
 A list of all possible time stepping methods. More...
 
enum  BoundaryCondition {
  interpolation =0, symmetry =11, dirichletBoundaryCondition =12, axisymmetric =13,
  interfaceBoundaryCondition =17, neumannBoundaryCondition =18, dirichletInterface =21, neumannInterface =22,
  noSlipWall =1, slipWall =4, noSlipWallInterface =19, slipWallInterface =20,
  penaltyBoundaryCondition =100
}
 A list of boundary conditions that are common to many solvers. More...
 
enum  InterfaceTypeEnum { noInterface, heatFluxInterface, tractionInterface, tractionAndHeatFluxInterface }
 
enum  InterfaceDataEnum {
  heatFluxInterfaceData = 1, positionInterfaceData = heatFluxInterfaceData << 1, velocityInterfaceData = positionInterfaceData << 1, accelerationInterfaceData = velocityInterfaceData << 1,
  tractionInterfaceData = accelerationInterfaceData << 1, tractionRateInterfaceData = tractionInterfaceData << 1
}
 
enum  BoundaryConditionType {
  uniformInflow, uniformInflowRamped, uniformInflowOscillating, uniformInflowWithTimeDependence,
  parabolicInflow, parabolicInflowRamped, parabolicInflowOscillating, parabolicInflowUserDefinedTimeDependence,
  parabolicInflowWithTimeDependence, blasiusProfile, rampInflow, jetInflow,
  jetInflowRamped, jetInflowOscillating, jetInflowUserDefinedTimeDependence, jetInflowWithTimeDependence,
  ramped, parabolicRamped, parabolicOscillating, parabolicUserDefinedTimeDependence,
  numberOfPredefinedBoundaryConditionTypes
}
 A list of different forms that a boundary condition can take. More...
 
enum  ImplicitMethod {
  notImplicit =0, backwardEuler, secondOrderBDF, crankNicolson,
  lineImplicit, trapezoidal, approximateFactorization
}
 
enum  ImplicitOption { computeAllTerms, doNotComputeImplicitTerms, computeImplicitTermsSeparately, computeAllWithWeightedImplicitTerms }
 
enum  InitialConditionOption {
  noInitialConditionChosen, uniformInitialCondition, readInitialConditionFromShowFile, readInitialConditionFromRestartFile,
  userDefinedInitialCondition, stepFunctionInitialCondition, twilightZoneFunctionInitialCondition, spinDownInitialCondition,
  knownSolutionInitialCondition
}
 
enum  TwilightZoneChoice { polynomial, trigonometric, pulse }
 
enum  ReactionTypeEnum {
  noReactions =0, oneStep, branching, ignitionAndGrowth,
  oneEquationMixtureFraction, twoEquationMixtureFractionAndExtentOfReaction, chemkinReaction, oneStepPress,
  igDesensitization, ignitionPressureReactionRate
}
 
enum  InterpolationTypeEnum { defaultInterpolationType, interpolateConservativeVariables, interpolatePrimitiveVariables, interpolatePrimitiveAndPressure }
 
enum  ReferenceFrameEnum { fixedReferenceFrame =0, rigidBodyReferenceFrame, specifiedReferenceFrame }
 
enum  KnownSolutionsEnum { noKnownSolution =0, userDefinedKnownSolution, knownSolutionFromAShowFile }
 
typedef std::map< int, aString >
::iterator 
BCIterator
 
typedef BCModifier *(* CreateBCModifierFromName )(const aString &name)
 
typedef std::map< size_t,
BCModifier * >::iterator 
BCModifierIterator
 
typedef std::map< std::string,
CreateBCModifierFromName >
::iterator 
BCModCreatorIterator
 

Public Member Functions

 CnsParameters (const int &numberOfDimensions0=3)
 
 ~CnsParameters ()
 
virtual int conservativeToPrimitive (GridFunction &gf, int gridToConvert=-1, int fixupUnsedPoints=false)
 Convert conservative variables to primitive.
 
virtual int displayPdeParameters (FILE *file=stdout)
 Display PDE parameters.
 
virtual int getDerivedFunction (const aString &name, const realCompositeGridFunction &u, realCompositeGridFunction &v, const int component, const real t, Parameters &parameters)
 Assign the values of a derived quantity.
 
virtual int getDerivedFunction (const aString &name, const realMappedGridFunction &u, realMappedGridFunction &v, const int grid, const int component, const real t, Parameters &parameters)
 Assign the values of a derived quantity.
 
virtual int getNormalForce (realCompositeGridFunction &u, realSerialArray &normalForce, int *ipar, real *rpar)
 Return the normal force on a boundary.
 
virtual int primitiveToConservative (GridFunction &gf, int gridToConvert=-1, int fixupUnsedPoints=false)
 Convert primitive variables to conservative.
 
virtual int saveParametersToShowFile ()
 Save PDE specific parameters in the show file.
 
virtual int setParameters (const int &numberOfDimensions0=2, const aString &reactionName=nullString)
 initialize the parameters.
 
virtual int setPdeParameters (CompositeGrid &cg, const aString &command=nullString, DialogData *interface=NULL)
 Prompt for changes in the PDE parameters.
 
virtual int setTwilightZoneFunction (const TwilightZoneChoice &choice, const int &degreeSpace=2, const int &degreeTime=1)
 set the twilight-zone function.
 
virtual int setUserDefinedParameters ()
 Set user defined parameters.
 
virtual int updatePDEparameters ()
 Update the PDE parameters to be consistent after some values have changed.
 
virtual int buildReactions ()
 Construction the appropriate Reactions class.
 
virtual int updateUserDefinedEOS (GenericGraphicsInterface &gi)
 Interactively select a user defined Equation of State (EOS).
 
virtual bool useConservativeVariables (int grid=-1) const
 return true if the PDE solver uses conservative variables.
 
virtual int numberOfGhostPointsNeeded () const
 return the number of ghost points needed by this method.
 
virtual int get (const GenericDataBase &dir, const aString &name)
 
virtual int put (GenericDataBase &dir, const aString &name)
 
virtual int assignParameterValues (const aString &label, RealArray &values, const int &numRead, aString *c, real val[], char *extraName1, const int &extraValue1Location, char *extraName2, const int &extraValue2Location, char *extraName3, const int &extraValue3Location)
 
virtual int updateToMatchGrid (CompositeGrid &cg, IntegerArray &sharedBoundaryCondition=Overture::nullIntArray())
 Update the parameters when the grid has changed.
 
virtual int getComponents (IntegerArray &components)
 Get an array of component indices. IS THIS USED ANYMORE? YES, BY THE RAMP BC.
 
virtual int setDefaultDataForABoundaryCondition (const int &side, const int &axis, const int &grid, CompositeGrid &cg)
 
virtual bool isMixedBC (int bc)
 
- Public Member Functions inherited from Parameters
bool registerBC (int id, const aString &name, bool replace=false)
 Add a bc with an integer identifier and a string name.
 
bool registerInterfaceType (int id, const aString &name, bool replace=false)
 Add a interface type with an integer identifier and a string name.
 
bool registerBCModifier (const aString &name, Parameters::CreateBCModifierFromName createBCMod, bool replace=false)
 Add a bc modifier with an integer identifier and a string name.
 
 Parameters (const int &numberOfDimensions0=3)
 constructor.
 
virtual ~Parameters ()
 destructor.
 
virtual int addShowVariable (const aString &name, int component, bool variableIsOn=TRUE)
 Add a show variable name to the list of possible show file variables.
 
int addTiming (const aString &timeVariableName, const aString &timeLabel)
 Add a new item to be timed. : name of the variable in the dbase : label to be used on output.
 
virtual int assignParameterValues (const aString &label, RealArray &values, const int &numRead, char c[][10], real val[], char *extraName1=0, const int &extraValue1Location=0, char *extraName2=0, const int &extraValue2Location=0, char *extraName3=0, const int &extraValue3Location=0)
 
virtual int bcIsAnInterface (int bc) const
 Return true if the bc value corresponds to an interface boundary condition.
 
virtual int bcIsTimeDependent (int side, int axis, int grid) const
 Return true if the boundary face has a boundary condition that varies in time.
 
virtual int bcType (int side, int axis, int grid) const
 Return the boundary condition type, a value from the enum Parameters::BoundaryConditionType.
 
virtual int bcVariesInSpace (int side, int axis, int grid) const
 Return true if the boundary face has a boundary condition that varies in space.
 
virtual int bcVariesInSpace (const Index &side=nullIndex, const Index &axis=nullIndex, const Index &grid=nullIndex) const
 Return true if any of a set of boundary faces has a boundary condition that varies in space.
 
virtual int buildBodyForceRegionsDialog (DialogData &dialog, BodyForceRegionParameters &regionPar)
 Build the dialog that defines different regions for body forces and boundary data.
 
virtual int buildErrorEstimator ()
 build the AMR error estimator.
 
virtual int buildForcingProfilesDialog (DialogData &dialog, BodyForceRegionParameters &regionPar)
 Build the dialog that defines different profiles for the forcing (.e.g. parabolic shape)
 
virtual int buildMaterialParametersDialog (DialogData &dialog, BodyForceRegionParameters &regionPar)
 Build the dialog that allows material parameters to be set.
 
virtual int buildTemperatureBoundaryConditionsDialog (DialogData &dialog, BodyForceRegionParameters &regionPar)
 Build the dialog that defines different options for the temperature boundary condition on a region. For example, set the right-hand-side or define the coefficients in the temperature BC equation.
 
virtual int checkForValidBoundaryCondition (const int &bc, bool reportErrors=true)
 
virtual int chooseUserDefinedBoundaryValues (int side, int axis, int grid, CompositeGrid &cg)
 Interactively define user specific values for boundary conditions.
 
virtual int defineBoundaryConditions (CompositeGrid &cg, const IntegerArray &originalBoundaryCondition, const aString &command=nullString, DialogData *interface=NULL)
 
virtual int defineVariableBoundaryValues (int side, int axis, int grid, CompositeGrid &cg)
 Interactively define boundary values that vary along a boundary. This function is called from setBoundaryConditionValues.
 
virtual void displayPolynomialCoefficients (RealArray &cx, RealArray &ct, aString *componentName, int numberOfComponents, FILE *file)
 Output the form of the polynomial TZ solution .
 
virtual int getBodyForceRegionsOption (const aString &answer, BodyForceRegionParameters &regionPar, DialogData &dialog)
 : Look for a response to the BodyForceDialog
 
RealArray & getBoundaryData (int side, int axis, int grid, MappedGrid &mg)
 Allocate the boundary data for a given side of a grid.
 
BoundaryData::BoundaryDataArraygetBoundaryData (int grid)
 return the boundary data for a grid
 
virtual int getForcingProfilesOption (const aString &answer, BodyForceRegionParameters &regionPar, DialogData &dialog)
 : Look for a response to the ForcingProfiles
 
virtual int getGridIsImplicit (int grid) const
 Return 1 or 2 if the grid is integrated implicitity.
 
virtual realCompositeGridFunction & getKnownSolution (CompositeGrid &cg, real t)
 Return a known solution.
 
virtual realMappedGridFunction & getKnownSolution (real t, int grid, const Index &I1, const Index &I2, const Index &I3, bool initialCall=false)
 Return a known solution on a component grid.
 
virtual int getMaterialParametersOption (const aString &answer, BodyForceRegionParameters &regionPar, DialogData &dialog)
 : Look for a response to the MaterialParametersDialog
 
const ReferenceFrameEnum getReferenceFrame ()
 return the reference frame for the PDEs in a domain.
 
int getShowVariable (const aString &name, int &component, bool &variableIsOn) const
 Return the component number of a show variable with a given name. Also return whether the variable is saved in the show file.
 
virtual int getTemperatureBoundaryConditionsOption (const aString &answer, BodyForceRegionParameters &regionPar, DialogData &dialog)
 : Look for a response to the ForcingProfiles
 
virtual int getTimeDependenceBoundaryConditionParameters (int side, int axis, int grid, RealArray &values) const
 Retrieve time dependent boundary values.
 
virtual aString getTimeSteppingName () const
 return the name of the time-stepping method
 
virtual int getUserBoundaryConditionParameters (int side, int axis, int grid, RealArray &values) const
 Retrieve user defined boundary values.
 
virtual int getUserDefinedKnownSolution (real t, CompositeGrid &cg, int grid, realArray &ua, const Index &I1, const Index &I2, const Index &I3)
 
virtual bool gridIsMoving (int grid) const
 return true if this grid is moving.
 
virtual int howManyBcTypes (const Index &side, const Index &axis, const Index &grid, BoundaryConditionType bc) const
 Return the number of faces where there is a boundary condition of type "bc", from the specified faces.
 
virtual int initializeTimings ()
 Define the items that will be timed (this is a virtual function that may be overloaded by derived classes)
 
virtual int inputParameterValues (const aString &answer, const aString &label, RealArray &values)
 Parse an input string "answer" that assigns values to components.
 
virtual bool isAdaptiveGridProblem () const
 
virtual bool isAxisymmetric () const
 return true if this is an axisymmetric problem on a 2D grid
 
virtual bool isMovingGridProblem () const
 return true if this is a moving grid problem.
 
virtual bool isSteadyStateSolver () const
 return true if this is a steady state problem.
 
virtual int numberOfGhostPointsNeededForImplicitMatrix () const
 return the number of ghost points needed by this method for the implicit matrix.
 
virtual int openLogFiles (const aString &name)
 Open the log files.
 
virtual int parseValues (const aString &answer, aString *name, real *value, int maxNumber)
 
virtual int put (GenericDataBase &dir, const aString &name) const
 
virtual int readFromAShowFile (ShowFileReader &showFileReader, CompositeGrid &cgRef, CompositeGrid &cg, realCompositeGridFunction &u, int &solutionNumber)
 : interface for reading a solution (e.g. initial condition or known solution) from a show file.
 
virtual bool saveLinearizedSolution ()
 Return true if we should save the linearized solution for implicit methods.
 
virtual int setBcIsTimeDependent (int side, int axis, int grid, bool trueOrFalse=true)
 Specify whether a boundary face has a boundary condition that varies in time.
 
virtual int setBcType (int side, int axis, int grid, BoundaryConditionType bc)
 Set the boundary condition type for a particular side.
 
virtual int setBcModifier (int side, int axis, int grid, int bcm)
 Set the boundary condition midifier id.
 
virtual int setBcVariesInSpace (int side, int axis, int grid, bool trueOrFalse=true)
 Specify whether a boundary face has a boundary condition that varies in space.
 
virtual int setBoundaryConditionValues (const aString &answer, const IntegerArray &originalBoundaryCondition, CompositeGrid &cg)
 
virtual int setGridIsImplicit (int grid=-1, int value=1)
 Specify if this grid should be integrated implicitly when an implicit time stepping method is used.
 
virtual int setInfoFile (FILE *file)
 specify which file to write informational messages to.
 
int setShowVariable (const aString &name, const bool variableIsOn)
 Turn on or off the saving of a variable in the show file. saved in the show file.
 
virtual int setTimeDependenceBoundaryConditionParameters (int side, int axis, int grid, RealArray &values)
 Assign time dependent boundary values.
 
virtual int setTwilightZoneParameters (CompositeGrid &cg, const aString &command=nullString, DialogData *interface=NULL)
 Prompt for changes to the twilight zone parameters.
 
virtual int setUserBcType (int side, int axis, int grid, int bc)
 Set the user defined boundary condition type for a particular side.
 
virtual int thereAreTimeDependentUserBoundaryConditions (const Index &side, const Index &axis, const Index &grid) const
 Return true if there are time dependent user boundary condition.
 
virtual int setupBodyForcing (CompositeGrid &cg)
 
virtual int setUserBoundaryConditionParameters (int side, int axis, int grid, RealArray &values)
 Assign user defined boundary values.
 
virtual int updateKnownSolutionToMatchGrid (CompositeGrid &cg)
 Update the known solution to match the grid.
 
virtual int updateShowFile (const aString &command=nullString, DialogData *interface=NULL)
 Open or close show files, set variables that appear in the show file.
 
virtual int updateTurbulenceModels (CompositeGrid &cg)
 Update turbulence models.
 
virtual int updateUserDefinedKnownSolution (GenericGraphicsInterface &gi)
 
virtual int userBcType (int side, int axis, int grid) const
 Return the user defined boundary condition type.
 

Additional Inherited Members

- Public Attributes inherited from Parameters
DataBase dbase
 The database holds almost all parameters, see dbase entries.
 
aString pdeName
 
int numberOfBCNames
 
std::map< int, aString > bcNames
 
std::map< int, aString > icNames
 
std::map< int, aString > bcmNames
 
std::map< size_t, BCModifier * > bcModifiers
 
std::map< std::string,
CreateBCModifierFromName
bcModCreators
 
- Static Public Attributes inherited from Parameters
static aString turbulenceModelName [numberOfTurbulenceModels+1]
 
static aString timeSteppingName [numberOfTimeSteppingMethods+1]
 
static real spalartAllmarasScaleFactor =1.
 
static real spalartAllmarasDistanceScale =1.e-10
 
static int checkForFloatingPointErrors =0
 

Detailed Description

This class holds parameters for Cgcns.

Member Enumeration Documentation

Enumerator
inflowWithVelocityGiven 
outflow 
superSonicInflow 
superSonicOutflow 
subSonicInflow 
subSonicOutflow 
convectiveOutflow 
tractionFree 
farField 
Enumerator
idealGasEOS 
jwlEOS 
mieGruneisenEOS 
userDefinedEOS 
stiffenedGasEOS 
taitEOS 
Enumerator
fortranVersion 
cppVersionI 
cppVersionII 
multiComponentVersion 
multiFluidVersion 
Enumerator
compressibleNavierStokes 
compressibleMultiphase 
Enumerator
nonConservative 
conservativeWithArtificialDissipation 
conservativeGodunov 
Enumerator
exactRiemannSolver 
roeRiemannSolver 
futureRiemannSolver 
hLLRiemannSolver 
Enumerator
standard 
laminarFlame 

Constructor & Destructor Documentation

CnsParameters::CnsParameters ( const int &  numberOfDimensions0 = 3)
CnsParameters::~CnsParameters ( )

Member Function Documentation

int CnsParameters::assignParameterValues ( const aString &  label,
RealArray &  values,
const int &  numRead,
aString *  c,
real  val[],
char *  extraName1,
const int &  extraValue1Location,
char *  extraName2,
const int &  extraValue2Location,
char *  extraName3,
const int &  extraValue3Location 
)
virtual
int CnsParameters::buildReactions ( )
virtual

Construction the appropriate Reactions class.

Reimplemented from Parameters.

References Parameters::buildReactions(), conservativeGodunov, Parameters::dbase, and jwlEOS.

Referenced by setParameters().

int CnsParameters::conservativeToPrimitive ( GridFunction gf,
int  gridToConvert = -1,
int  fixupUnsedPoints = false 
)
virtual

Convert conservative variables to primitive.

Parameters
gf(input) : convert this grid function.
gridToConvert(input) : (grid==-1) convert all grids, otherwise convert this grid.
fixupUnsedPoints(input) : if true, fixup unused points.
Note
  • primitive : rho, u,v,w, T, species
  • conservative rho, (rho*u), (rho*v), (rho*w), E, (rho*species)

Reimplemented from Parameters.

References ADDPSI, all, GridFunction::cg, cg, conservativeGodunov, CONSPRIM, Parameters::dbase, e, eosUserDefined, GridFunction::form, form, grid, jwlEOS, mask, multiComponentVersion, GridFunction::primitiveVariables, printF(), rho, s, tc, GridFunction::u, u, uc, useConservativeVariables(), v, vc, and wc.

int CnsParameters::displayPdeParameters ( FILE *  file = stdout)
virtual

Display PDE parameters.

Parameters
file(input) : output information to this file.

Reimplemented from Parameters.

References compressibleMultiphase, compressibleNavierStokes, conservativeGodunov, conservativeWithArtificialDissipation, Parameters::dbase, Parameters::displayPdeParameters(), and nonConservative.

int CnsParameters::get ( const GenericDataBase &  dir,
const aString &  name 
)
virtual

Reimplemented from Parameters.

References Parameters::dbase, and Parameters::get().

int CnsParameters::getComponents ( IntegerArray &  components)
virtual

Get an array of component indices. IS THIS USED ANYMORE? YES, BY THE RAMP BC.

Parameters
components(output): the list of component indices.

Reimplemented from Parameters.

References Parameters::dbase, and n.

int CnsParameters::getDerivedFunction ( const aString &  name,
const realCompositeGridFunction &  u,
realCompositeGridFunction &  v,
const int  component,
const real  t,
Parameters parameters 
)
virtual

Assign the values of a derived quantity.

This function knows how to compute some "derived" quantities. For example for the compressible Navier-Stokes, the pressure can be computed.

Parameters
name(input) the name of the derived quantity.
u(input) : evaluate the derived function using this grid function.
v(input) : fill in a component of this grid function.
component(input) : component index to fill, i.e. fill v(all,all,all,component)
parameters(input) :

Reimplemented from Parameters.

References cg, grid, and ok.

int CnsParameters::getDerivedFunction ( const aString &  name,
const realMappedGridFunction &  uIn,
realMappedGridFunction &  vIn,
const int  grid,
const int  component,
const real  t,
Parameters parameters 
)
virtual

Assign the values of a derived quantity.

This function knows how to compute some "derived" quantities. For example for the compressible Navier-Stokes, the pressure can be computed.

Parameters
name(input) : the name of the derived quantity.
uIn(input) : evaluate the derived function using this grid function.
vIn(input) : fill in a component of this grid function.
component(input) : component index to fill, i.e. fill v(all,all,all,component)
parameters(input) :

Reimplemented from Parameters.

References all, compressibleMultiphase, compressibleNavierStokes, Parameters::dbase, idealGasEOS, jwlEOS, mg, mieGruneisenEOS, multiComponentVersion, multiFluidVersion, pc, stiffenedGasEOS, taitEOS, tc, u, userDefinedEOS, and v.

int CnsParameters::getNormalForce ( realCompositeGridFunction &  u,
realSerialArray &  normalForce,
int *  ipar,
real *  rpar 
)
virtual

Return the normal force on a boundary.

This routine is called, for example, by MovingGrids::rigidBodyMotion to determine the motion of a rigid body.

Parameters
u(input): solution to compute the force from.
normalForce(output) : fill in the components of the normal force.
ipar(input) : integer parameters. The boundary is defined by grid=ipar[0], side=ipar[1], axis=ipar[2]
rpar(input) : real parameters. The current time is t=rpar[0]

Reimplemented from Parameters.

References assert(), axis, cg, Parameters::dbase, fn, form, grid, idealGasEOS, lambda, mask, mg, mu, normal, GridFunction::primitiveVariables, printF(), side, stiffenedGasEOS, tc, uc, ux, uy, uz, V, vc, and wc.

bool CnsParameters::isMixedBC ( int  bc)
virtual
int CnsParameters::numberOfGhostPointsNeeded ( ) const
virtual
int CnsParameters::primitiveToConservative ( GridFunction gf,
int  gridToConvert = -1,
int  fixupUnsedPoints = false 
)
virtual

Convert primitive variables to conservative.

Parameters
gf(input) : convert this grid function.
gridToConvert(input) : (grid==-1) convert all grids, otherwise convert this grid.
fixupUnsedPoints(input) : if true, fixup unused points.
Note
  • primitive : rho, u,v,w, T, species
  • conservative rho, (rho*u), (rho*v), (rho*w), E, (rho*species)

Reimplemented from Parameters.

References ADDPSI, all, GridFunction::cg, cg, conservativeGodunov, GridFunction::conservativeVariables, CONSPRIM, Parameters::dbase, eosUserDefined, GridFunction::form, form, grid, jwlEOS, mask, multiComponentVersion, printF(), rho, s, tc, GridFunction::u, u, uc, useConservativeVariables(), v, vc, and wc.

int CnsParameters::put ( GenericDataBase &  dir,
const aString &  name 
)
virtual
int CnsParameters::saveParametersToShowFile ( )
virtual
int CnsParameters::setDefaultDataForABoundaryCondition ( const int &  side,
const int &  axis,
const int &  grid,
CompositeGrid &  cg 
)
virtual
int CnsParameters::setParameters ( const int &  numberOfDimensions0 = 2,
const aString &  reactionName = nullString 
)
virtual
int CnsParameters::setPdeParameters ( CompositeGrid &  cg,
const aString &  command = nullString,
DialogData *  interface = NULL 
)
virtual
int CnsParameters::setTwilightZoneFunction ( const TwilightZoneChoice choice_,
const int &  degreeSpace = 2,
const int &  degreeTime = 1 
)
virtual

set the twilight-zone function.

Parameters
choice_(input) : the twilight-zone option.
degreeSpace(input) : the degree in space for a polynomial function.
degreeTime(input) : the degree in time for a polynomial function.

Reimplemented from Parameters.

References all, amplitude, assert(), cc, compressibleMultiphase, compressibleNavierStokes, Parameters::dbase, ec, ft, fx, fy, fz, gt, gx, gy, gz, i, kc, Parameters::kEpsilon, Parameters::kOmega, multiComponentVersion, multiFluidVersion, n, nc, Parameters::noTurbulenceModel, omega, pc, Parameters::polynomial, printF(), Parameters::pulse, setAmplitudes(), setCoefficients(), setConstants(), setShifts(), Parameters::SpalartAllmaras, spatialCoefficientsForTZ, tc, timeCoefficientsForTZ, Parameters::trigonometric, uc, vc, and wc.

int CnsParameters::setUserDefinedParameters ( )
virtual
int CnsParameters::updatePDEparameters ( )
virtual

Update the PDE parameters to be consistent after some values have changed.

Update the dimensional PDE parameters such as mu if the non-dimensional parameters (Reynolds number, mach number etc) were specified.

Reimplemented from Parameters.

References compressibleNavierStokes, Parameters::dbase, Parameters::defaultValue, and printF().

Referenced by setPdeParameters().

int CnsParameters::updateToMatchGrid ( CompositeGrid &  cg,
IntegerArray &  sharedBoundaryCondition = Overture::nullIntArray() 
)
virtual

Update the parameters when the grid has changed.

Parameters
cg(input) : new CompositeGrid
sharedBoundaryCondition(input) : sharedBoundaryCondition(side,axis,grid) : = side2+2*(axis2+3*grid2) : match to (side2,axis2,grid2)

Reimplemented from Parameters.

References all, compressibleMultiphase, compressibleNavierStokes, conservativeGodunov, Parameters::dbase, Parameters::notImplicit, and Parameters::updateToMatchGrid().

int CnsParameters::updateUserDefinedEOS ( GenericGraphicsInterface &  gi)
virtual
bool CnsParameters::useConservativeVariables ( int  grid = -1) const
virtual

return true if the PDE solver uses conservative variables.

Parameters
grid(input): if grid!=-1 then check if this grid uses conservative variables, otherwise check if by default we use conservative variables

Reimplemented from Parameters.

References assert(), compressibleMultiphase, compressibleNavierStokes, Parameters::dbase, equationDomainList, EquationDomain::getPDE(), grid, ListOfEquationDomains::gridDomainNumberList, and nonConservative.

Referenced by conservativeToPrimitive(), and primitiveToConservative().


The documentation for this class was generated from the following files: