AsfParameters Class Reference

#include <AsfParameters.h>

Inheritance diagram for AsfParameters:

Collaboration diagram for AsfParameters:

Public Types
enum	BoundaryConditions { subSonicInflow =8, subSonicOutflow =10, convectiveOutflow =14, tractionFree =15 }
enum	AlgorithmVariation { defaultAlgorithm =0, densityFromGasLawAlgorithm }
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
	AsfParameters (const int &numberOfDimensions0=3)
	~AsfParameters ()
virtual int	displayPdeParameters (FILE *file=stdout)
	Display PDE parameters.
virtual int	getDerivedFunction (const aString &name, const realCompositeGridFunction &u, realCompositeGridFunction &v, const int component, Parameters &parameters)
virtual int	getDerivedFunction (const aString &name, const realMappedGridFunction &u, realMappedGridFunction &vIn, const int grid, const int component, Parameters &parameters)
virtual int	getNormalForce (realCompositeGridFunction &u, realSerialArray &normalForce, int *ipar, real *rpar)
	Return the normal force on a boundary.
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	updatePDEparameters ()
	Update the PDE parameters to be consistent after some values have 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, aString *c, 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	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	buildReactions ()
	Construction the appropriate Reactions class.
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	conservativeToPrimitive (GridFunction &gf, int gridToConvert=-1, int fixupUnsedPoints=false)
	Convert conservative variables to primitive.
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	get (const GenericDataBase &dir, const aString &name)
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::BoundaryDataArray &	getBoundaryData (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	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 component, const int grid, const real t, Parameters &parameters)
	Assign the values of a derived quantity.
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	numberOfGhostPointsNeeded () const
	return the number of ghost points needed by this method.
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	primitiveToConservative (GridFunction &gf, int gridToConvert=-1, int fixupUnsedPoints=false)
	Convert primitive variables to conservative.
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	setUserDefinedParameters ()
	Set user defined parameters.
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	updateToMatchGrid (CompositeGrid &cg, IntegerArray &sharedBoundaryCondition=Overture::nullIntArray())
	Update the parameters when the grid has changed.
virtual int	updateTurbulenceModels (CompositeGrid &cg)
	Update turbulence models.
virtual int	updateUserDefinedEOS (GenericGraphicsInterface &gi)
virtual int	updateUserDefinedKnownSolution (GenericGraphicsInterface &gi)
virtual bool	useConservativeVariables (int grid=-1) const
	return true if the PDE solver uses conservative variables.
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

Member Enumeration Documentation

enum AsfParameters::AlgorithmVariation

Enumerator
defaultAlgorithm
densityFromGasLawAlgorithm

enum AsfParameters::BoundaryConditions

Enumerator
subSonicInflow
subSonicOutflow
convectiveOutflow
tractionFree

enum AsfParameters::TestProblems

Enumerator
standard
laminarFlame

Constructor & Destructor Documentation

AsfParameters::AsfParameters

(

const int &

numberOfDimensions0 = 3

)

References convectiveOutflow, Parameters::dbase, densityFromGasLawAlgorithm, Parameters::implicitAllSpeed, Parameters::initializeTimings(), Parameters::registerBC(), standard, subSonicInflow, subSonicOutflow, and tractionFree.

AsfParameters::~AsfParameters

(

)

Member Function Documentation

int AsfParameters::displayPdeParameters ( FILE *  file = stdout )

virtual

Display PDE parameters.

Parameters

file	(input) : output information to this file.

Reimplemented from Parameters.

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

int AsfParameters::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 AsfParameters::getDerivedFunction ( const aString &  name, const realCompositeGridFunction &  u, realCompositeGridFunction &  v, const int  component, Parameters &  parameters  )

virtual

References cg, grid, and ok.

int AsfParameters::getDerivedFunction ( const aString &  name, const realMappedGridFunction &  u, realMappedGridFunction &  vIn, const int  grid, const int  component, Parameters &  parameters  )

virtual

References all, Parameters::dbase, mg, pc, tc, u, and v.

int AsfParameters::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, lambda, mask, mg, mu, normal, GridFunction::primitiveVariables, printF(), side, tc, uc, ux, uy, uz, V, vc, and wc.

bool AsfParameters::isMixedBC ( int  bc )

virtual

Reimplemented from Parameters.

References convectiveOutflow, and tractionFree.

int AsfParameters::saveParametersToShowFile ( )

virtual

Save PDE specific parameters in the show file.

These parameters can be used for a restart. They can also be used, for example, by the user defined derived functions (when viewing the show file with plotStuff).

Reimplemented from Parameters.

References assert(), Parameters::branching, Parameters::chemkinReaction, Parameters::dbase, Parameters::igDesensitization, Parameters::ignitionAndGrowth, Parameters::noReactions, Parameters::oneEquationMixtureFraction, Parameters::oneStep, Parameters::oneStepPress, Parameters::saveParametersToShowFile(), and Parameters::twoEquationMixtureFractionAndExtentOfReaction.

int AsfParameters::setDefaultDataForABoundaryCondition ( const int &  side, const int &  axis, const int &  grid, CompositeGrid &  cg  )

virtual

Reimplemented from Parameters.

References all, axis, boundaryCondition(), convectiveOutflow, Parameters::dbase, mixedCoeff, mixedNormalCoeff, mixedRHS, Parameters::noSlipWall, pc, side, subSonicInflow, and subSonicOutflow.

int AsfParameters::setParameters ( const int &  numberOfDimensions0 = 2, const aString &  reactionName = nullString  )

virtual

initialize the parameters.

Parameters

numberOfDimensions0	(input) : number of dimensions.
reactionName	(input) : optional name of a reaction oe a reaction file that defines the chemical reactions, such as a Chemkin binary file.

Reimplemented from Parameters.

References Parameters::addShowVariable(), assert(), Parameters::buildReactions(), Parameters::dbase, Parameters::defaultValue, e, Reactions::getName(), i, Parameters::implicitAllSpeed, n, s, and Parameters::SpalartAllmaras.

int AsfParameters::setPdeParameters ( CompositeGrid &  cg, const aString &  command = nullString, DialogData *  interface = NULL  )

virtual

Prompt for changes in the PDE parameters.

Parameters

cg	(input) : Composite grid to use.
command	(input) : if non-null, parse this string for a command.
interface	(input) : use this graphics dialog.

Reimplemented from Parameters.

References assert(), Parameters::dbase, defaultAlgorithm, Parameters::defaultInterpolationType, densityFromGasLawAlgorithm, i, if(), Parameters::interpolateConservativeVariables, Parameters::interpolatePrimitiveAndPressure, Parameters::interpolatePrimitiveVariables, m, n, printF(), Parameters::spalartAllmarasDistanceScale, Parameters::spalartAllmarasScaleFactor, and updatePDEparameters().

int AsfParameters::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 amplitude, cc, Parameters::dbase, ft, fx, fy, fz, gt, gx, gy, gz, i, n, Parameters::polynomial, printF(), Parameters::pulse, setAmplitudes(), setCoefficients(), setConstants(), setShifts(), spatialCoefficientsForTZ, timeCoefficientsForTZ, and Parameters::trigonometric.

int AsfParameters::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 Parameters::dbase, Parameters::defaultValue, and printF().

Referenced by setPdeParameters().

---

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

• AsfParameters.h
• AsfParameters.C