A class to hold PDE parameters for a DomainSolver. More...

#include <Parameters.h>

Inheritance diagram for Parameters:

Classes
class	BCModifier

Public Types
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
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 int	displayPdeParameters (FILE *file=stdout)
	Display PDE parameters.

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	getComponents (IntegerArray &components)
	Get an array of component indices. IS THIS USED ANYMORE? YES, BY THE RAMP BC.

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

virtual int	getNormalForce (realCompositeGridFunction &u, realSerialArray &normalForce, int ipar, real rpar)
	Return the normal force on a boundary.

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	isMixedBC (int bc)

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	saveParametersToShowFile ()
	Save PDE specific parameters in the show file.

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	setDefaultDataForABoundaryCondition (const int &side, const int &axis, const int &grid, 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.

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.

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	setTwilightZoneFunction (const TwilightZoneChoice &choice, const int &degreeSpace=2, const int &degreeTime=2)
	set the twilight-zone function.

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	updatePDEparameters ()
	Update the PDE parameters to be consistent after some values have changed.

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.

Public Attributes
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
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

A class to hold PDE parameters for a DomainSolver.

This base class object holds generic parameters.

Member Typedef Documentation

typedef std::map<int,aString>::iterator Parameters::BCIterator

typedef std::map<std::string,CreateBCModifierFromName>::iterator Parameters::BCModCreatorIterator

typedef std::map<size_t,BCModifier*>::iterator Parameters::BCModifierIterator

typedef BCModifier*(* Parameters::CreateBCModifierFromName)(const aString &name)

Member Enumeration Documentation

enum Parameters::BoundaryCondition

A list of boundary conditions that are common to many solvers.

Enumerator
interpolation
symmetry
dirichletBoundaryCondition
axisymmetric
interfaceBoundaryCondition
neumannBoundaryCondition
dirichletInterface
neumannInterface
noSlipWall
slipWall
noSlipWallInterface
slipWallInterface
penaltyBoundaryCondition

enum Parameters::BoundaryConditionType

A list of different forms that a boundary condition can take.

Enumerator
uniformInflow	inflow profile is constant in space.
uniformInflowRamped	inflow profile is constant in space, ramped in time.
uniformInflowOscillating	inflow profile is constant in space, oscillating in time.
uniformInflowWithTimeDependence
parabolicInflow	inflow profile is parabolic in space.
parabolicInflowRamped	inflow profile is parabolic in space, ramped in time.
parabolicInflowOscillating	inflow profile is parabolic in space, oscillating in time.
parabolicInflowUserDefinedTimeDependence	inflow profile is parabolic in space, user defined time dependence.
parabolicInflowWithTimeDependence
blasiusProfile	kkc added for bl and turbulence model testing
rampInflow
jetInflow
jetInflowRamped
jetInflowOscillating
jetInflowUserDefinedTimeDependence
jetInflowWithTimeDependence
ramped
parabolicRamped
parabolicOscillating
parabolicUserDefinedTimeDependence
numberOfPredefinedBoundaryConditionTypes

enum Parameters::ForcingType

Enumerator
noForcing
showfileForcing
numberOfForcingTypes

enum Parameters::ImplicitMethod

Enumerator
notImplicit
backwardEuler
secondOrderBDF
crankNicolson
lineImplicit
trapezoidal
approximateFactorization

enum Parameters::ImplicitOption

Enumerator
computeAllTerms
doNotComputeImplicitTerms
computeImplicitTermsSeparately
computeAllWithWeightedImplicitTerms

enum Parameters::InitialConditionOption

Enumerator
noInitialConditionChosen
uniformInitialCondition
readInitialConditionFromShowFile
readInitialConditionFromRestartFile
userDefinedInitialCondition
stepFunctionInitialCondition
twilightZoneFunctionInitialCondition
spinDownInitialCondition
knownSolutionInitialCondition

enum Parameters::InterfaceDataEnum

Enumerator
heatFluxInterfaceData
positionInterfaceData
velocityInterfaceData
accelerationInterfaceData
tractionInterfaceData
tractionRateInterfaceData

enum Parameters::InterfaceTypeEnum

Enumerator
noInterface
heatFluxInterface
tractionInterface
tractionAndHeatFluxInterface

enum Parameters::InterpolationTypeEnum

Enumerator
defaultInterpolationType
interpolateConservativeVariables
interpolatePrimitiveVariables
interpolatePrimitiveAndPressure

enum Parameters::KnownSolutionsEnum

Enumerator
noKnownSolution
userDefinedKnownSolution
knownSolutionFromAShowFile

enum Parameters::ReactionTypeEnum

Enumerator
noReactions
oneStep
branching
ignitionAndGrowth
oneEquationMixtureFraction
twoEquationMixtureFractionAndExtentOfReaction
chemkinReaction
oneStepPress
igDesensitization
ignitionPressureReactionRate

enum Parameters::ReferenceFrameEnum

Enumerator
fixedReferenceFrame
rigidBodyReferenceFrame
specifiedReferenceFrame

enum Parameters::Stuff

Enumerator
defaultValue
maximumNumberOfOutputFiles

enum Parameters::TimeSteppingMethod

A list of all possible time stepping methods.

Enumerator
forwardEuler	forward euler
adamsBashforth2	second-order Adams-Bashforth
adamsPredictorCorrector2	second-order Adams predcitor-corrector
adamsPredictorCorrector4
variableTimeStepAdamsPredictorCorrector
laxFriedrichs
implicit	implicit predictor-corrector
rKutta
midPoint
implicitAllSpeed
implicitAllSpeed2
nonMethodOfLines
steadyStateRungeKutta
steadyStateNewton
secondOrderSystemTimeStepping
adi
numberOfTimeSteppingMethods

enum Parameters::TurbulenceModel

Enumerator
noTurbulenceModel
BaldwinLomax
kEpsilon
kOmega
SpalartAllmaras
LargeEddySimulation
numberOfTurbulenceModels

enum Parameters::TwilightZoneChoice

Enumerator
polynomial
trigonometric
pulse

Constructor & Destructor Documentation

Parameters::Parameters ( const int & numberOfDimensions0 = 3 )

constructor.

Parameters

numberOfDimensions0 (input) : number of space dimensions for the problem.

The dbase member data is a DataBase that contains most parameters in this class. By creating parameters dynamically (rather than declaring them directly in the class) it is easier to add new variables and easier to automatically save the values to a file.

Here is a list of values in the dbase (classes that derive from Parameters will define more entries):

allowUserDefinedOutput (int) : if true call the userDefinedOutput function.

detectCollisions (bool) : if true detect collisions between bodies.

globalStepNumber (bool) : global step number for time-stepping or iterations

showResdiuals (int) : if true show the residuals

statistics (RealArray) : an array to hold statistics.

timeSequence (RealArray) : array to hold time sequences such as the residual norm over time.

twilightZoneFlow (bool) : true if we are testing solutions with twilightzone flow.

pdeParameters (int) : sub-directory of user defined pde parameters.

reciprocalActivationEnergyB (real) : parameter for the ignition and growth model.

References adamsBashforth2, adamsPredictorCorrector2, adamsPredictorCorrector4, adi, axisymmetric, backwardEuler, computeAllTerms, dbase, defaultInterpolationType, defaultValue, dirichletBoundaryCondition, dirichletInterface, e, fixedReferenceFrame, forwardEuler, heatFluxInterface, implicit, implicitAllSpeed, interfaceBoundaryCondition, interpolation, laxFriedrichs, maximumNumberOfOutputFiles, midPoint, n, neumannBoundaryCondition, neumannInterface, noForcing, noInitialConditionChosen, noInterface, noKnownSolution, nonMethodOfLines, noReactions, noSlipWall, noSlipWallInterface, notImplicit, noTurbulenceModel, numberOfTimeSteppingMethods, penaltyBoundaryCondition, polynomial, registerBC(), registerInterfaceType(), secondOrderSystemTimeStepping, slipWall, slipWallInterface, steadyStateNewton, steadyStateRungeKutta, symmetry, timeSteppingName, tractionAndHeatFluxInterface, tractionInterface, turbulenceModelName, and variableTimeStepAdamsPredictorCorrector.

Parameters::~Parameters ( )

virtual

destructor.

References bcModifiers, dbase, i, maximumNumberOfOutputFiles, and n.

Member Function Documentation

int Parameters::addShowVariable	(	const aString &	name,
		int	component,
		bool	variableIsOn = `TRUE`
	)

virtual

Add a show variable name to the list of possible show file variables.

Parameters

name	(input) : name to give the show variable.
component	(input) : the component number of this variable (if it is a computational variable), otherwise a positive integer larger than any component number.
variableIsOn	(input) : if true this variable will be saved in the show file. If false the variable will not be saved by default but the user can change this.

Note: showVariable(i) >0 if we are to save showVariableName[i], <0 we do not save.

References dbase, and i.

Referenced by get(), AdParameters::setParameters(), AsfParameters::setParameters(), SmParameters::setParameters(), CnsParameters::setParameters(), InsParameters::setParameters(), and setParameters().

int Parameters::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.

Returns: value: the item's index in the timing array.

References dbase.

Referenced by SmParameters::initializeTimings(), and initializeTimings().

int Parameters::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

Reimplemented in CnsParameters.

References dbase, defaultValue, i, n, printF(), and rho.

Referenced by CnsParameters::assignParameterValues(), inputParameterValues(), and setBoundaryConditionValues().

int Parameters::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

References dbase, defaultValue, i, n, printF(), and rho.

int Parameters::bcIsAnInterface ( int bc ) const

virtual

Return true if the bc value corresponds to an interface boundary condition.

Parameters

bc	(input) : boundary condition.

Returns: Return true if the bc value corresponds to an interface boundary condition.

References dirichletInterface, interfaceBoundaryCondition, neumannInterface, noSlipWallInterface, and slipWallInterface.

int Parameters::bcIsTimeDependent	(	int	side,
		int	axis,
		int	grid
	)		const

virtual

Return true if the boundary face has a boundary condition that varies in time.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid

Returns: return true if the boundary face has a boundary condition that varies in time.

References dbase.

Referenced by Cgasf::gridAccelerationBC(), Cgins::gridAccelerationBC(), and thereAreTimeDependentUserBoundaryConditions().

int Parameters::bcType	(	int	side,
		int	axis,
		int	grid
	)		const

virtual

Return the boundary condition type, a value from the enum Parameters::BoundaryConditionType.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid number.

Returns: return the boundary condition type for a given face of a grid.

References dbase.

Referenced by Cgins::applyBoundaryConditions(), DomainSolver::getTimeDependentBoundaryConditions(), DomainSolver::jetInflow(), DomainSolver::parabolicInflow(), DomainSolver::setup(), and DomainSolver::userDefinedBoundaryValues().

int Parameters::bcVariesInSpace	(	int	side,
		int	axis,
		int	grid
	)		const

virtual

Return true if the boundary face has a boundary condition that varies in space.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid

Returns: return true if the boundary face has a boundary condition that varies in space.

References dbase.

Referenced by DomainSolver::getTimeDependentBoundaryConditions(), DomainSolver::initializeSolution(), and Cgsm::setup().

int Parameters::bcVariesInSpace	(	const Index &	side = `nullIndex`,
		const Index &	axis = `nullIndex`,
		const Index &	grid = `nullIndex`
	)		const

virtual

Return true if any of a set of boundary faces has a boundary condition that varies in space.

Parameters

side	(input) : side(s)
axis	(input) : axis(s)
grid	(input) : grid(s)

Returns: return true if any of a set of boundary faces has a boundary condition that varies in space.

References dbase.

int Parameters::buildBodyForceRegionsDialog	(	DialogData &	dialog,
		BodyForceRegionParameters &	regionPar
	)

virtual

Build the dialog that defines different regions for body forces and boundary data.

Parameters

dialog (input) : graphics dialog to use.

References assert(), linesToPlot, xe, ye, and ze.

Referenced by defineVariableBoundaryValues(), and setupBodyForcing().

int Parameters::buildErrorEstimator ( )

virtual

build the AMR error estimator.

References assert(), and dbase.

Referenced by DomainSolver::adaptGrids(), DomainSolver::addGrids(), DomainSolver::displayParameters(), get(), DomainSolver::getAdaptiveGridOption(), DomainSolver::getAmrErrorFunction(), and DomainSolver::newAdaptiveGridBuilt().

int Parameters::buildForcingProfilesDialog	(	DialogData &	dialog,
		BodyForceRegionParameters &	regionPar
	)

virtual

Build the dialog that defines different profiles for the forcing (.e.g. parabolic shape)

Parameters

dialog (input) : graphics dialog to use.

References assert().

Referenced by defineVariableBoundaryValues().

int Parameters::buildMaterialParametersDialog	(	DialogData &	dialog,
		BodyForceRegionParameters &	regionPar
	)

virtual

Build the dialog that allows material parameters to be set.

Parameters

dialog (input) : graphics dialog to use.

References assert(), dbase, lambda, m, mu, pdeName, and rho.

Referenced by setupBodyForcing().

int Parameters::buildReactions ( )

virtual

Construction the appropriate Reactions class.

Reimplemented in CnsParameters.

References dbase.

Referenced by CnsParameters::buildReactions(), AsfParameters::setParameters(), InsParameters::setParameters(), and setParameters().

int Parameters::buildTemperatureBoundaryConditionsDialog	(	DialogData &	dialog,
		BodyForceRegionParameters &	regionPar
	)

virtual

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.

Parameters

dialog (input) : graphics dialog to use.

References assert().

Referenced by defineVariableBoundaryValues().

int Parameters::checkForValidBoundaryCondition	(	const int &	bc,
		bool	reportErrors = `true`
	)

virtual

References bcNames, and printF().

Referenced by defineBoundaryConditions(), DomainSolver::displayBoundaryConditions(), and setBoundaryConditionValues().

int Parameters::chooseUserDefinedBoundaryValues	(	int	side,
		int	axis,
		int	grid,
		CompositeGrid &	cg
	)

virtual

Interactively define user specific values for boundary conditions.

This function will be called when interactively choosing boundary conditions and the option userDefinedBoundaryData is used.

You may add a time dependence to an existing boundary condition or you may define a new boundary condition. In this function you should prompt for the boundary condition to be used as well as any parameters that will be needed. Parameters can be saved using the setUserBoundaryConditionParameters function.

Note: : The actual boundary values are NOT assigned in this routine. This is done in the userDefinedBoundaryValues function.

Parameters

side,axis,grid (input): assign boundary conditions for this face.

Reimplemented in SmParameters.

References assert(), axis, d, dbase, grid, OV_ABORT(), printF(), setBcIsTimeDependent(), setUserBcType(), setUserBoundaryConditionParameters(), side, u0, and update().

Referenced by setBoundaryConditionValues().

int Parameters::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 in CnsParameters.

Referenced by GridFunction::conservativeToPrimitive().

int Parameters::defineBoundaryConditions	(	CompositeGrid &	cg,
		const IntegerArray &	originalBoundaryCondition,
		const aString &	command = `nullString`,
		DialogData *	interface = `NULL`
	)

virtual

References addPrefix(), all, assert(), axis, bcNames, checkForValidBoundaryCondition(), dbase, for(), get(), grid, i, inputParameterValues(), interpolation, n, noSlipWall, numberOfBCNames, printF(), setBoundaryConditionValues(), and side.

Referenced by DomainSolver::setParametersInteractively().

int Parameters::defineVariableBoundaryValues	(	int	side,
		int	axis,
		int	grid,
		CompositeGrid &	cg
	)

virtual

Interactively define boundary values that vary along a boundary. This function is called from setBoundaryConditionValues.

This function can be used to define sub-regions on a boundary where the boundary values take on certain values. For example, one can set the temperature on one

Note: : The actual boundary values are NOT assigned in this routine. This is done in the setVariableBoundaryValues function.

Parameters

side,axis,grid (input): assign boundary conditions for this face.

References a0, addBoundaryForce, assert(), axis, buildBodyForceRegionsDialog(), buildForcingProfilesDialog(), buildTemperatureBoundaryConditionsDialog(), dbase, dir, display(), FOR_3D, forcingType, TimeFunction::get(), getBodyForceRegionsOption(), getForcingProfilesOption(), getIndex(), getTemperatureBoundaryConditionsOption(), BoundaryData::getVariableCoefficientBoundaryConditionArray(), grid, i, i1, I1, i2, I2, i3, I3, includeGhost, isRectangular, lines, linesToPlot, maskLocal, mg, mixedCoeff, mixedNormalCoeff, ok, OV_ABORT(), printF(), profileFactor, profileType, rad, side, tc, TimeFunction::update(), BoundaryData::variableCoefficientTemperatureBC, xab, XC, xe, xv, ye, and ze.

Referenced by setBoundaryConditionValues().

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

virtual

Display PDE parameters.

Parameters

file	(input) : output information to this file.

Reimplemented in CnsParameters, SmParameters, InsParameters, AsfParameters, MpParameters, and AdParameters.

References dbase, e, and s.

Referenced by DomainSolver::displayParameters(), AdParameters::displayPdeParameters(), MpParameters::displayPdeParameters(), AsfParameters::displayPdeParameters(), InsParameters::displayPdeParameters(), SmParameters::displayPdeParameters(), and CnsParameters::displayPdeParameters().

void Parameters::displayPolynomialCoefficients	(	RealArray &	cx,
		RealArray &	ct,
		aString *	componentName,
		int	numberOfComponents,
		FILE *	file
	)

virtual

Output the form of the polynomial TZ solution .

Parameters

cx	(input) : spatial coefficients
ct	(input) : time coefficients.
componentName	(input) : array of component names.
numberOfComponents	(input) : number of components.
file	(input) : write output to this file.

References n, and ndp.

Referenced by setTwilightZoneParameters().

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

virtual

Reimplemented in CnsParameters.

References addShowVariable(), assert(), buildErrorEstimator(), dbase, GET_OR_PUT, i, and printF().

Referenced by defineBoundaryConditions(), CnsParameters::get(), readRestartFile(), DomainSolver::readRestartFile(), and setTwilightZoneParameters().

int Parameters::getBodyForceRegionsOption	(	const aString &	answer,
		BodyForceRegionParameters &	regionPar,
		DialogData &	dialog
	)

virtual

: Look for a response to the BodyForceDialog

Parameters

answer	(input) : check this command
regionPar	(output) : changes to the region are returned in this object.

Returns: return 1 if the command was found, 0 otherwise.

References cg, dbase, linesToPlot, printF(), xe, ye, and ze.

Referenced by defineVariableBoundaryValues(), and setupBodyForcing().

RealArray & Parameters::getBoundaryData	(	int	side,
		int	axis,
		int	grid,
		MappedGrid &	mg
	)

Allocate the boundary data for a given side of a grid.

Some boundary data may have so be saved since it is too expensive to recompute. e.g. parabolicInfow Return an array to use on a given face (allocate it if necessary)

Parameters

side,axis,grid	(input) : face
mg	(input) : the MappedGrid

References assert(), axis, dbase, grid, I1, I2, I3, includeGhost, maskLocal, ok, printF(), and side.

Referenced by Cgsm::advanceFOS(), Cgcns::applyBoundaryConditions(), Cgad::applyBoundaryConditions(), Cgasf::applyBoundaryConditions(), Cgins::applyBoundaryConditions(), Cgcns::applyBoundaryConditionsForImplicitTimeStepping(), Cgad::applyBoundaryConditionsForImplicitTimeStepping(), Cgins::applyBoundaryConditionsForImplicitTimeStepping(), Cgins::applyFourthOrderBoundaryConditions(), Cgsm::assignBoundaryConditionsFOS(), Cgsm::assignBoundaryConditionsSOS(), DomainSolver::getTimeDependentBoundaryConditions(), Cgasf::gridAccelerationBC(), Cgins::gridAccelerationBC(), Cgins::initializeTurbulenceModels(), DeformingBodyMotion::integrate(), DomainSolver::jetInflow(), DomainSolver::parabolicInflow(), DomainSolver::setInterfacesAtPastTimes(), DomainSolver::setVariableBoundaryValues(), Cgsm::userDefinedBoundaryValues(), and DomainSolver::userDefinedBoundaryValues().

BoundaryData::BoundaryDataArray & Parameters::getBoundaryData ( int grid )

return the boundary data for a grid

References assert(), dbase, and grid.

int Parameters::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 in CnsParameters, InsParameters, and AsfParameters.

References components, dbase, and n.

Referenced by Cgcns::formMatrixForImplicitSolve(), and DomainSolver::getTimeDependentBoundaryConditions().

int Parameters::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 in CnsParameters.

References cg, grid, and ok.

Referenced by Cgcns::getAugmentedSolution(), Cgins::getAugmentedSolution(), DomainSolver::interpolate(), and DomainSolver::saveShow().

int Parameters::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 in InsParameters, and CnsParameters.

References mg.

int Parameters::getForcingProfilesOption	(	const aString &	answer,
		BodyForceRegionParameters &	regionPar,
		DialogData &	dialog
	)

virtual

: Look for a response to the ForcingProfiles

Parameters

answer	(input) : check this command
regionPar	(output) : changes to the region are returned in this object.

Returns: return 1 if the command was found, 0 otherwise.

References dbase, OV_ABORT(), printF(), and profileType.

Referenced by defineVariableBoundaryValues().

int Parameters::getGridIsImplicit ( int grid ) const

virtual

Return 1 or 2 if the grid is integrated implicitity.

This requires that both the time stepping method is an implicit one and that the grid was chosen to be implicit.

Parameters

grid	(input) : grid

Returns: return 1=implicit, 2= semi-implicit

References dbase, implicit, implicitAllSpeed, steadyStateNewton, and steadyStateRungeKutta.

Referenced by Cgins::addForcing(), Cgasf::addForcing(), DomainSolver::advanceImplicitMultiStep(), Cgins::advanceLineSolveNew(), Cgins::advanceLineSolveOld(), Cgad::applyBoundaryConditions(), Cgad::applyBoundaryConditionsForImplicitTimeStepping(), Cgins::applyBoundaryConditionsForImplicitTimeStepping(), DomainSolver::applyBoundaryConditionsForImplicitTimeStepping(), Cgins::applyFourthOrderBoundaryConditions(), Cgins::buildImplicitSolvers(), DomainSolver::displayParameters(), Cgad::formMatrixForImplicitSolve(), Cgins::formMatrixForImplicitSolve(), DomainSolver::getTimeStep(), Cgcns::getTimeSteppingEigenvalue(), Cgad::getTimeSteppingEigenvalue(), Cgasf::getTimeSteppingEigenvalue(), Cgins::getTimeSteppingEigenvalue(), DomainSolver::getTimeSteppingOption(), Cgad::getUt(), Cgasf::getUt(), Cgins::getUt(), Cgins::insImplicitMatrix(), DomainSolver::takeTimeStepIM(), and DomainSolver::writeParameterSummary().

realCompositeGridFunction & Parameters::getKnownSolution	(	CompositeGrid &	cg,
		real	t
	)

virtual

Return a known solution.

Parameters

cg	(input) : match to this grid.
t	(input) : time to evaluate the known solution.

Returns: Return a reference to the known solution.

References all, dbase, getIndex(), grid, I1, I2, I3, and mg.

Referenced by Cgcns::applyBoundaryConditions(), Cgsm::assignInitialConditions(), DomainSolver::assignInitialConditions(), Cgins::determineErrors(), DomainSolver::determineErrors(), Cgcns::getAugmentedSolution(), Cgsm::getErrors(), and updateKnownSolutionToMatchGrid().

realMappedGridFunction & Parameters::getKnownSolution	(	real	t,
		int	grid,
		const Index &	I1,
		const Index &	I2,
		const Index &	I3,
		bool	initialCall = `false`
	)

virtual

Return a known solution on a component grid.

Parameters

t	(input) : time to evaluate the known solution.
grid	(input) : match to this grid.
I1	(input) :
I2	(input) :
I3	(input) :
initialCall	(input) : true if this is the initial call.

Returns: Return a reference to the known solution.

Note: This routine assumes that getKnownSolution(cg,t) has been intially called to allocate space.

References assert(), cg, dbase, getUserDefinedKnownSolution(), grid, gridIsMoving(), knownSolutionFromAShowFile, mg, OV_ABORT(), printF(), and userDefinedKnownSolution.

int Parameters::getMaterialParametersOption	(	const aString &	answer,
		BodyForceRegionParameters &	regionPar,
		DialogData &	dialog
	)

virtual

: Look for a response to the MaterialParametersDialog

Parameters

answer	(input) : check this command
regionPar	(output) : changes to the region are returned in this object.

Returns: return 1 if the command was found, 0 otherwise.

References GridMaterialProperties::constantMaterialProperties, dbase, m, OV_ABORT(), GridMaterialProperties::piecewiseConstantMaterialProperties, printF(), and GridMaterialProperties::variableMaterialProperties.

Referenced by setupBodyForcing().

int Parameters::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 in CnsParameters, InsParameters, and AsfParameters.

References printF().

Referenced by MovingGrids::rigidBodyMotion().

const Parameters::ReferenceFrameEnum Parameters::getReferenceFrame ( )

return the reference frame for the PDEs in a domain.

The frame of reference is needed so that we know how to transform the PDE when the grids move. Often the PDEs are defined in a fixed reference frame (even if some boundaries are moving). If we are solving for a PDE inside a moving rigid body, then the PDE (e.g. the heat equation) may be defined in the frame of reference of the rigid body.

References dbase.

Referenced by Cgad::addForcing(), Cgad::advanceADI(), Cgad::getTimeSteppingEigenvalue(), and Cgad::getUt().

int Parameters::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.

Parameters

name	(input) : name of the show variable to lookup.
component	(output) : the component number of this show variable (return -1 if the name is not found)
variableIsOn	(output) : if true this variable will be saved in the show file. If false the variable will not be saved by default but the user can change this.

References dbase, and i.

int Parameters::getTemperatureBoundaryConditionsOption	(	const aString &	answer,
		BodyForceRegionParameters &	regionPar,
		DialogData &	dialog
	)

virtual

: Look for a response to the ForcingProfiles

Parameters

answer	(input) : check this command
regionPar	(output) : changes to the region are returned in this object.

Returns: return 1 if the command was found, 0 otherwise.

References a0, dbase, OV_ABORT(), and printF().

Referenced by defineVariableBoundaryValues().

int Parameters::getTimeDependenceBoundaryConditionParameters	(	int	side,
		int	axis,
		int	grid,
		RealArray &	values
	)		const

virtual

Retrieve time dependent boundary values.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid
values	(output) : boundary condition values (on input this array must be the correct length).

References dbase, printF(), and R.

Referenced by DomainSolver::getTimeDependentBoundaryConditions().

aString Parameters::getTimeSteppingName ( ) const

virtual

return the name of the time-stepping method

Reimplemented in SmParameters.

References dbase, numberOfTimeSteppingMethods, and timeSteppingName.

Referenced by DomainSolver::displayParameters(), and DomainSolver::writeParameterSummary().

int Parameters::getUserBoundaryConditionParameters	(	int	side,
		int	axis,
		int	grid,
		RealArray &	values
	)		const

virtual

Retrieve user defined boundary values.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid
values	(output) : boundary condition values (on input this array must be the correct length).

References axis, dbase, printF(), R, and side.

Referenced by Cgsm::userDefinedBoundaryValues(), and DomainSolver::userDefinedBoundaryValues().

int Parameters::getUserDefinedKnownSolution	(	real	t,
		CompositeGrid &	cg,
		int	grid,
		realArray &	ua,
		const Index &	I1,
		const Index &	I2,
		const Index &	I3
	)

virtual

References a0, a2, assert(), c1, c2, center, dbase, FluidPiston::fluidSolidRiemannProblem(), FOR_3D, FlowSolutions::forcedPistonMotion, gam, FlowSolutions::getFlowSolution(), grid, i, i1, i2, i3, lambda, m, mg, mu, FlowSolutions::obliqueShockFlow, omega, printF(), r, rotatingDiskSVK, S, s11c, s12c, s21c, s22c, FlowSolutions::shockElasticPiston, FlowSolutions::specifiedPistonMotion, FlowSolutions::superSonicExpandingFlow, tc, theta, u, u0, uc, updateUserDefinedKnownSolution(), v1c, v2c, vc, vs0, x, and y.

Referenced by getKnownSolution().

bool Parameters::gridIsMoving ( int grid ) const

virtual

return true if this grid is moving.

Parameters

grid	(input) : grid number.

References dbase.

Referenced by DomainSolver::adaptGrids(), Cgad::addForcing(), Cgins::addForcing(), Cgcns::addForcing(), Cgins::addForcingToPressureEquation(), Cgasf::addForcingToPressureEquation(), DomainSolver::advanceAdamsPredictorCorrector(), Cgad::advanceADI(), DomainSolver::advanceImplicitMultiStep(), Cgins::advanceLineSolveNew(), Cgins::advanceLineSolveOld(), DomainSolver::advanceSecondOrderSystem(), Cgasf::allSpeedImplicitTimeStep(), PenaltyWallFunctionBC::applyBC(), Cgcns::applyBoundaryConditions(), Cgasf::applyBoundaryConditions(), Cgins::applyBoundaryConditions(), Cgcns::applyBoundaryConditionsForImplicitTimeStepping(), Cgins::applyBoundaryConditionsForImplicitTimeStepping(), Cgins::applyFourthOrderBoundaryConditions(), Cgins::assignPressureRHS(), Cgins::determineErrors(), DomainSolver::determineErrors(), DomainSolver::displayParameters(), DomainSolver::eulerStep(), Cgcns::formImplicitTimeSteppingMatrix(), Cgins::formMatrixForImplicitSolve(), Cgcns::getAugmentedSolution(), getKnownSolution(), Cgins::getResidual(), Cgcns::getTimeSteppingEigenvalue(), Cgad::getTimeSteppingEigenvalue(), Cgasf::getTimeSteppingEigenvalue(), Cgins::getTimeSteppingEigenvalue(), Cgad::getUt(), Cgcns::getUt(), Cgasf::getUt(), Cgins::getUt(), Cgasf::gridAccelerationBC(), Cgins::gridAccelerationBC(), DomainSolver::initializeTimeSteppingIM(), DomainSolver::initializeTimeSteppingPC(), Cgins::insImplicitMatrix(), DomainSolver::moveGrids(), DomainSolver::outputProbes(), DomainSolver::setInterfacesAtPastTimes(), DomainSolver::setup(), DomainSolver::setupGridFunctions(), DomainSolver::setVariableBoundaryValues(), Cgasf::solveForAllSpeedPressure(), Cgasf::solveForTimeIndependentVariables(), DomainSolver::takeTimeStepFE(), Cgad::updateGeometryArrays(), Cgins::updateGeometryArrays(), GridFunction::updateGridVelocityArrays(), Cgins::updatePressureEquation(), Cgsm::userDefinedBoundaryValues(), DomainSolver::userDefinedBoundaryValues(), and DomainSolver::writeParameterSummary().

int Parameters::howManyBcTypes	(	const Index &	side,
		const Index &	axis,
		const Index &	grid,
		BoundaryConditionType	bc
	)		const

virtual

Return the number of faces where there is a boundary condition of type "bc", from the specified faces.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid number.
bc	(input) : check for this boundary condition.

Returns: return the number of faces where the boundary condition is bc

References dbase.

Referenced by DomainSolver::parabolicInflow().

int Parameters::initializeTimings ( )

virtual

Define the items that will be timed (this is a virtual function that may be overloaded by derived classes)

Reimplemented in SmParameters.

References addTiming(), dbase, and printF().

Referenced by AdParameters::AdParameters(), AsfParameters::AsfParameters(), CnsParameters::CnsParameters(), InsParameters::InsParameters(), and MpParameters::MpParameters().

int Parameters::inputParameterValues	(	const aString &	answer,
		const aString &	label,
		RealArray &	values
	)

virtual

Parse an input string "answer" that assigns values to components.

Input parameter values from a string of the form: `u=1., v=2., ...' where the names on the left-hand-side of the equal operator should correspond to one of

Parameters

answer	(input) : string containing the parameter value specification of the form: `u=1., v=2., ...'
label	(input) : print this label when showing the responses. For example label="initial conditions".
values	(output) : return values in this array. For example the assignment `u=1.' will result in values(parameters.dbase.get<int >("uc"))=1.

Returns: return the number of variables assigned.

References assignParameterValues(), and parseValues().

Referenced by defineBoundaryConditions(), DomainSolver::getInitialConditions(), and DomainSolver::setupUserDefinedInitialConditions().

virtual bool Parameters::isAdaptiveGridProblem ( ) const

inlinevirtual

Referenced by DomainSolver::advance(), Cgsm::advance(), DomainSolver::advanceAdamsPredictorCorrector(), Cgsm::advanceFOS(), DomainSolver::advanceImplicitMultiStep(), Cgsm::advanceMethodOfLines(), DomainSolver::advanceSecondOrderSystem(), Cgins::applyFourthOrderBoundaryConditions(), Cgsm::assignBoundaryConditionsFOS(), Cgsm::assignBoundaryConditionsSOS(), DomainSolver::endTimeStepFE(), DomainSolver::eulerStep(), Cgcns::getAugmentedSolution(), Cgsm::getAugmentedSolution(), Cgins::getAugmentedSolution(), DomainSolver::getAugmentedSolution(), DomainSolver::getInitialConditions(), Cgsm::getTimeStep(), DomainSolver::getTimeStepAndNumberOfSubSteps(), Cgmp::initializeInterfaces(), DomainSolver::initializeTimeSteppingIM(), DomainSolver::initializeTimeSteppingPC(), Cgmp::multiDomainAdvance(), Cgmp::multiDomainAdvanceNew(), DomainSolver::newAdaptiveGridBuilt(), DomainSolver::printStatistics(), readFromAShowFile(), Cgsm::solve(), DomainSolver::startTimeStepFE(), DomainSolver::takeTimeStepFE(), DomainSolver::takeTimeStepIM(), DomainSolver::takeTimeStepPC(), Cgins::updateForMovingGrids(), DomainSolver::updateForMovingGrids(), and GridFunction::updateGridVelocityArrays().

bool Parameters::isAxisymmetric ( ) const

virtual

return true if this is an axisymmetric problem on a 2D grid

References dbase.

Referenced by Cgcns::addConstraintEquation(), Cgad::addForcing(), Cgins::addForcing(), Cgins::addForcingToPressureEquation(), Cgins::advanceLineSolveNew(), Cgins::advanceLineSolveOld(), Cgcns::applyBoundaryConditions(), Cgins::applyBoundaryConditions(), Cgcns::applyBoundaryConditionsForImplicitTimeStepping(), Cgins::applyBoundaryConditionsForImplicitTimeStepping(), Cgins::applyFourthOrderBoundaryConditions(), Cgins::assignPressureRHS(), Cgcns::buildImplicitSolvers(), Cgins::buildImplicitSolvers(), Cgcns::formImplicitTimeSteppingMatrix(), Cgad::formMatrixForImplicitSolve(), Cgins::formMatrixForImplicitSolve(), Cgins::getAugmentedSolution(), Cgcns::getTimeSteppingEigenvalue(), Cgad::getTimeSteppingEigenvalue(), Cgasf::getTimeSteppingEigenvalue(), Cgins::getTimeSteppingEigenvalue(), Cgad::getUt(), Cgcns::getUt(), Cgasf::getUt(), Cgins::getUt(), Cgins::insImplicitMatrix(), Cgins::printTimeStepInfo(), Cgins::project(), DomainSolver::project(), InsParameters::saveParametersToShowFile(), DomainSolver::saveShow(), Cgins::saveShowFileComments(), Cgins::setPlotTitle(), InsParameters::setTwilightZoneFunction(), Cgins::setupGridFunctions(), Cgins::updateDivergenceDamping(), Cgins::updateGeometryArrays(), Cgins::updatePressureEquation(), and DomainSolver::writeParameterSummary().

bool Parameters::isMixedBC ( int bc )

virtual

Reimplemented in CnsParameters, InsParameters, and AsfParameters.

Referenced by setBoundaryConditionValues().

bool Parameters::isMovingGridProblem ( ) const

virtual

return true if this is a moving grid problem.

References dbase.

Referenced by DomainSolver::advance(), DomainSolver::advanceAdamsPredictorCorrector(), DomainSolver::advanceImplicitMultiStep(), DomainSolver::advanceSecondOrderSystem(), DomainSolver::applyBoundaryConditions(), DomainSolver::buildAmrGridsForInitialConditions(), DomainSolver::displayParameters(), DomainSolver::eulerStep(), Cgins::formMatrixForImplicitSolve(), Cgcns::getAugmentedSolution(), Cgins::getAugmentedSolution(), DomainSolver::getInitialConditions(), DomainSolver::getTimeStep(), Cgasf::getTimeSteppingEigenvalue(), Cgasf::getUt(), DomainSolver::initializeSolution(), DomainSolver::initializeTimeSteppingIM(), DomainSolver::initializeTimeSteppingPC(), Cgmp::interfaceProjection(), DomainSolver::moveGrids(), DomainSolver::movingGridProblem(), readFromAShowFile(), Cgmp::saveShow(), Cgsm::saveShow(), DomainSolver::saveShow(), DomainSolver::setParametersInteractively(), DomainSolver::setup(), DomainSolver::setupGridFunctions(), Cgmp::solve(), DomainSolver::takeTimeStepFE(), DomainSolver::takeTimeStepPC(), DomainSolver::updateForAdaptiveGrids(), Cgins::updateForMovingGrids(), DomainSolver::updateForMovingGrids(), Cgins::updatePressureEquation(), and DomainSolver::writeParameterSummary().

bool Parameters::isSteadyStateSolver ( ) const

virtual

return true if this is a steady state problem.

References dbase, steadyStateNewton, and steadyStateRungeKutta.

Referenced by DomainSolver::advance(), DomainSolver::buildPlotOptionsDialog(), Cgmp::buildRunTimeDialog(), DomainSolver::buildRunTimeDialog(), DomainSolver::computeNumberOfStepsAndAdjustTheTimeStep(), DomainSolver::getResidualInfo(), Cgmp::plot(), DomainSolver::plot(), Cgcns::printTimeStepInfo(), Cgasf::printTimeStepInfo(), Cgins::printTimeStepInfo(), DomainSolver::printTimeStepInfo(), Cgsm::saveShow(), DomainSolver::saveShow(), Cgins::setPlotTitle(), and Cgmp::solve().

int Parameters::numberOfGhostPointsNeeded ( ) const

virtual

return the number of ghost points needed by this method.

Reimplemented in CnsParameters, and InsParameters.

References dbase.

Referenced by Cgcns::applyBoundaryConditions(), Cgins::applyBoundaryConditions(), Cgcns::formMatrixForImplicitSolve(), InsParameters::numberOfGhostPointsNeeded(), CnsParameters::numberOfGhostPointsNeeded(), InsParameters::numberOfGhostPointsNeededForImplicitMatrix(), numberOfGhostPointsNeededForImplicitMatrix(), and DomainSolver::outputSolution().

int Parameters::numberOfGhostPointsNeededForImplicitMatrix ( ) const

virtual

return the number of ghost points needed by this method for the implicit matrix.

Reimplemented in InsParameters.

References numberOfGhostPointsNeeded().

Referenced by Cgins::formMatrixForImplicitSolve().

int Parameters::openLogFiles ( const aString & name )

virtual

Open the log files.

Parameters

name	(input) : name for the prefix of the log files: name.debug, name.check, name.log, name.move.

References assert(), dbase, and np.

Referenced by DomainSolver::setParametersInteractively().

int Parameters::parseValues	(	const aString &	answer,
		aString *	name,
		real *	value,
		int	maxNumber
	)

virtual

References dbase, i, j, and printF().

Referenced by inputParameterValues(), and setBoundaryConditionValues().

int Parameters::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 in CnsParameters.

Referenced by GridFunction::primitiveToConservative().

int Parameters::put	(	GenericDataBase &	dir,
		const aString &	name
	)		const

virtual

References dir, GET_OR_PUT, i, and printF().

Referenced by CnsParameters::put(), and DomainSolver::saveRestartFile().

int Parameters::readFromAShowFile	(	ShowFileReader &	showFileReader,
		CompositeGrid &	cgRef,
		CompositeGrid &	cg,
		realCompositeGridFunction &	u,
		int &	solutionNumber
	)

virtual

: interface for reading a solution (e.g. initial condition or known solution) from a show file.

: this function can be used to read a solution from a show file, optionally choosing certain components and optionally computing derived quantites (such as pressure from density and temperature or components of the stress tensor from displacements). This function can also be used to interpolate the solution from the show file onto the reference grid.

Parameters

showFileReader	: use this show file reader
cgRef	(input) : reference grid (will be used if the solution from the show file needs to be interpolated to the current grid).
cg	(output) : output grid (
u	(output) : output solution from the show file (if assigned). (output) : -1 means no solution was chosen. A non-negative value indicates which solution in the show file was chosen.

References all, assert(), c, dbase, getIndex(), grid, i, I1, I2, I3, isAdaptiveGridProblem(), isMovingGridProblem(), lambda, mg, mu, n, printF(), readInitialConditionFromShowFile, rho, S, s11c, s12c, s13c, s21c, s22c, s23c, s31c, s32c, s33c, ux, uy, and uz.

Referenced by setTwilightZoneParameters().

bool Parameters::registerBC	(	int	id,
		const aString &	name,
		bool	replace = `false`
	)

Add a bc with an integer identifier and a string name.

Parameters

id	(input) : identifier.
name	(input) : name of the boundary condition.
replace	(input) : if true, replace a boundary condition with the same id. If false do not replace.

Returns: This method returns true if the addition was ok, false if there is an existing bc with id and replace==false.

References bcNames, and numberOfBCNames.

Referenced by AdParameters::AdParameters(), AsfParameters::AsfParameters(), CnsParameters::CnsParameters(), InsParameters::InsParameters(), Parameters(), and SmParameters::SmParameters().

bool Parameters::registerBCModifier	(	const aString &	name,
		Parameters::CreateBCModifierFromName	createBCMod,
		bool	replace = `false`
	)

Add a bc modifier with an integer identifier and a string name.

Parameters

id	(input) : identifier.
name	(input) : name of the boundary condition.
createBCMod	(input) : a function pointer to a function that create's BCModifier instances with the name "name"
replace	(input) : if true, replace a boundary condition with the same id. If false do not replace.

Returns: This method returns true if the addition was ok, false if there is an existing bc with id and replace==false.

References bcModCreators.

Referenced by InsParameters::InsParameters().

bool Parameters::registerInterfaceType	(	int	id,
		const aString &	name,
		bool	replace = `false`
	)

Add a interface type with an integer identifier and a string name.

Parameters

id	(input) : identifier.
name	(input) : name of the interface type
replace	(input) : if true, replace a boundary interface with the same id. If false do not replace.

Returns: This method returns true if the addition was ok, false if there is an existing bc with id and replace==false.

References icNames.

Referenced by Parameters().

bool Parameters::saveLinearizedSolution ( )

virtual

Return true if we should save the linearized solution for implicit methods.

If implicit operator is non-linear then we may need to save the solution we linearize about.

Reimplemented in InsParameters.

Referenced by Cgins::formMatrixForImplicitSolve(), and Cgins::insImplicitMatrix().

int Parameters::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 in InsParameters, CnsParameters, SmParameters, AsfParameters, MpParameters, and AdParameters.

References assert(), cc, dbase, and i.

Referenced by AdParameters::saveParametersToShowFile(), MpParameters::saveParametersToShowFile(), AsfParameters::saveParametersToShowFile(), SmParameters::saveParametersToShowFile(), CnsParameters::saveParametersToShowFile(), InsParameters::saveParametersToShowFile(), Cgsm::saveShow(), and DomainSolver::saveShow().

int Parameters::setBcIsTimeDependent	(	int	side,
		int	axis,
		int	grid,
		bool	trueOrFalse = `true`
	)

virtual

Specify whether a boundary face has a boundary condition that varies in time.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid
trueOrFalse	(input) : true if the boundary face has a boundary condition that varies in time.

References dbase.

Referenced by SmParameters::chooseUserDefinedBoundaryValues(), chooseUserDefinedBoundaryValues(), and setBoundaryConditionValues().

int Parameters::setBcModifier	(	int	side,
		int	axis,
		int	grid,
		int	bcm
	)

virtual

Set the boundary condition midifier id.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid
bcm	(input) : boundary condition modifier id.

References dbase.

Referenced by setBoundaryConditionValues().

int Parameters::setBcType	(	int	side,
		int	axis,
		int	grid,
		BoundaryConditionType	bc
	)

virtual

Set the boundary condition type for a particular side.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid
bc	(input) : boundary condition type.

References dbase.

Referenced by setBoundaryConditionValues().

int Parameters::setBcVariesInSpace	(	int	side,
		int	axis,
		int	grid,
		bool	trueOrFalse = `true`
	)

virtual

Specify whether a boundary face has a boundary condition that varies in space.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid
trueOrFalse	(input) : true if the boundary face has a boundary condition that varies in space.

References dbase.

Referenced by setBoundaryConditionValues().

int Parameters::setBoundaryConditionValues	(	const aString &	answer,
		const IntegerArray &	originalBoundaryCondition,
		CompositeGrid &	cg
	)

virtual

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

virtual

Reimplemented in CnsParameters, InsParameters, AsfParameters, and AdParameters.

Referenced by setBoundaryConditionValues(), and DomainSolver::setDefaultDataForBoundaryConditions().

int Parameters::setGridIsImplicit	(	int	grid = `-1`,
		int	value = `1`
	)

virtual

Specify if this grid should be integrated implicitly when an implicit time stepping method is used.

Parameters

grid	(input) : grid to set, -1=set all
value	(input) : 1=implicit, 2=semi-implicit, 0 = not-implicit

References assert(), and dbase.

Referenced by DomainSolver::advance(), Cgcns::getTimeSteppingOption(), Cgad::getTimeSteppingOption(), Cgmp::getTimeSteppingOption(), Cgasf::getTimeSteppingOption(), Cgins::getTimeSteppingOption(), DomainSolver::getTimeSteppingOption(), and CnsParameters::setParameters().

int Parameters::setInfoFile ( FILE * file )

virtual

specify which file to write informational messages to.

Normally informational messages are sent to stdout. This can be changed by supplying a file to write to.

Parameters

file	(input) : file to write info messages to.

References assert(), and dbase.

int Parameters::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 in InsParameters, CnsParameters, SmParameters, AsfParameters, MpParameters, and AdParameters.

References addShowVariable(), assert(), buildReactions(), dbase, defaultValue, e, n, s, and SpalartAllmaras.

Referenced by MpParameters::setParameters(), and DomainSolver::setParametersInteractively().

int Parameters::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 in InsParameters, CnsParameters, SmParameters, AsfParameters, MpParameters, and AdParameters.

Referenced by Cgmp::buildRunTimeDialog(), DomainSolver::buildRunTimeDialog(), Cgmp::plot(), DomainSolver::plot(), and DomainSolver::setParametersInteractively().

int Parameters::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.

Parameters

name	(input) : name of the show variable to lookup.
variableIsOn	(input) : if true this variable will be saved in the show file. If false the variable will not be saved by default but the user can change this.

References dbase, i, and printF().

Referenced by Cgsm::getPlotOption().

int Parameters::setTimeDependenceBoundaryConditionParameters	(	int	side,
		int	axis,
		int	grid,
		RealArray &	values
	)

virtual

Assign time dependent boundary values.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid
values	(input) : boundary condition values.

References dbase, and R.

Referenced by setBoundaryConditionValues().

int Parameters::setTwilightZoneFunction	(	const TwilightZoneChoice &	choice_,
		const int &	degreeSpace = `2`,
		const int &	degreeTime = `2`
	)

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 in InsParameters, CnsParameters, SmParameters, AsfParameters, and AdParameters.

References amplitude, cc, dbase, ft, fx, fy, fz, gt, gx, gy, gz, i, kEpsilon, kOmega, n, nc, noTurbulenceModel, polynomial, printF(), pulse, setAmplitudes(), setCoefficients(), setConstants(), setShifts(), SpalartAllmaras, spatialCoefficientsForTZ, timeCoefficientsForTZ, and trigonometric.

Referenced by DomainSolver::getInitialConditions(), setTwilightZoneParameters(), and DomainSolver::setup().

int Parameters::setTwilightZoneParameters	(	CompositeGrid &	cg,
		const aString &	command = `nullString`,
		DialogData *	interface = `NULL`
	)

virtual

Prompt for changes to the twilight zone parameters.

Parameters

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

References addPrefix(), all, assert(), cx, dbase, displayPolynomialCoefficients(), get(), i1, i2, i3, if(), knownSolutionFromAShowFile, knownSolutionInitialCondition, n, ndp, noKnownSolution, omega, polynomial, printF(), pulse, readFromAShowFile(), setCoefficients(), setTwilightZoneFunction(), trigonometric, updateUserDefinedKnownSolution(), and userDefinedKnownSolution.

Referenced by DomainSolver::getInitialConditions(), and DomainSolver::setParametersInteractively().

int Parameters::setupBodyForcing ( CompositeGrid & cg )

virtual

References assert(), axis, buildBodyForceRegionsDialog(), buildMaterialParametersDialog(), dbase, TimeFunction::get(), getBodyForceRegionsOption(), getMaterialParametersOption(), i, lines, linesToPlot, m, OV_ABORT(), printF(), profileType, and TimeFunction::update().

Referenced by DomainSolver::setParametersInteractively().

int Parameters::setUserBcType	(	int	side,
		int	axis,
		int	grid,
		int	bc
	)

virtual

Set the user defined boundary condition type for a particular side.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid
bc	(input) : boundary condition number.

References dbase, and numberOfPredefinedBoundaryConditionTypes.

Referenced by SmParameters::chooseUserDefinedBoundaryValues(), and chooseUserDefinedBoundaryValues().

int Parameters::setUserBoundaryConditionParameters	(	int	side,
		int	axis,
		int	grid,
		RealArray &	values
	)

virtual

Assign user defined boundary values.

Parameters

side	(input) : side
axis	(input) : axis
grid	(input) : grid
values	(input) : boundary condition values.

References dbase, and R.

Referenced by SmParameters::chooseUserDefinedBoundaryValues(), and chooseUserDefinedBoundaryValues().

int Parameters::setUserDefinedParameters ( )

virtual

Set user defined parameters.

Reimplemented in InsParameters, and CnsParameters.

Referenced by DomainSolver::setParametersInteractively(), and DomainSolver::setup().

int Parameters::thereAreTimeDependentUserBoundaryConditions	(	const Index &	Side,
		const Index &	Axis,
		const Index &	Grid
	)		const

virtual

Return true if there are time dependent user boundary condition.

Parameters

Side	(input) : side(s)
Axis	(input) : axis(s)
Grid	(input) : grid(s)

References axis, bcIsTimeDependent(), dbase, grid, numberOfPredefinedBoundaryConditionTypes, S, and side.

Referenced by Cgsm::applyBoundaryConditions(), DomainSolver::applyBoundaryConditions(), and DomainSolver::getTimeDerivativeOfBoundaryValues().

int Parameters::updateKnownSolutionToMatchGrid ( CompositeGrid & cg )

virtual

Update the known solution to match the grid.

This routine will update the grid function that holds the known solution to be the correct dimensions. It will only evaluate the known solution if the knownSolution is being allocated for the first time.

Parameters

cg	(input) : match to this grid.

References all, dbase, getKnownSolution(), and noKnownSolution.

Referenced by updateToMatchGrid().

int Parameters::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 in CnsParameters, and AsfParameters.

Referenced by AdParameters::setPdeParameters(), MpParameters::setPdeParameters(), InsParameters::setPdeParameters(), and DomainSolver::setup().

int Parameters::updateShowFile	(	const aString &	command = `nullString`,
		DialogData *	interface = `NULL`
	)

virtual

Open or close show files, set variables that appear in the show file.

Parameters

command	(input) : optionally supply a command to execute. Attempt to execute the command and then return. The return value is 0 if the command was executed, 1 otherwise.
interface	(input) : use this dialog. If command=="build dialog", fill in the dialog and return.

Here are the show file options:

open : open a new show file.
close : close any open show file.
show file variables : specify extra derived quantities, such as the divergence or vorticity, that should be saved in the show file in addition to the standard variables.
frequency to save : By default the solution is saved in the show file as often as it is plotted according to "times to plot". To save the solution less often set this integer value to be greater than 1. A value of 2 for example will save solutions every 2nd time the solution is plot.
frequency to flush : Save this many solutions in each sub-show file so that no file gets too big. This will result in multiple show files being created (these are automatically handled by plotStuff).
uncompressed : save the show file uncompressed. This is a more portable format that can be read by future versions of Overture.
compressed : save the show file compressed. This is a less portable format.

References addPrefix(), assert(), dbase, i, if(), n, np, and printF().

Referenced by DomainSolver::getOutputOption(), Cgmp::plot(), DomainSolver::plot(), and DomainSolver::setParametersInteractively().

int Parameters::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+3grid2) : match to (side2,axis2,grid2)

Reimplemented in CnsParameters, and SmParameters.

References all, assert(), axis, boundaryCondition(), dbase, grid, mixedCoeff, mixedNormalCoeff, mixedRHS, n, noInterface, printF(), R, side, and updateKnownSolutionToMatchGrid().