QPot (version 1.0)

QPotential: Wrapper for call to quasipotential computation using the upwind ordered method

Description

Wrapper for call to quasipotential computation using the upwind ordered method

Usage

QPotential(x.rhs = "NULL", x.start = "NULL", x.bound = "NULL",
  x.num.steps = "NULL", y.rhs = "NULL", y.start = "NULL",
  y.bound = "NULL", y.num.steps = "NULL", filename = "NULL",
  save.to.R = TRUE, save.to.HD = FALSE, bounce = "d",
  bounce.edge = 0.01, verboseR = FALSE, verboseC = TRUE, debugC = FALSE,
  k.x = 20, k.y = 20)

Arguments

x.rhs

a string containing the right hand side of the equation for x.

x.start

the starting value of x, usually the x value of the current equilibrium.

x.bound

the x boundaries denoted at c(minimum, maximum).

x.num.steps

the number of steps between the minimum and maximum x value defined in x range.

y.rhs

a string containing the right hand side of the equation for y.

y.start

the starting value of y, usually the y value of the current equilibrium.

y.bound

the y boundaries denoted at c(minimum, maximum).

y.num.steps

the number of steps between the minimum and maximum y value defined in y range.

filename

string for the name of the file saved to the hard drive. If filename is left blank, output file saved as defaultname-xX.STARTyY.START.txt, where X.START and Y.START are values in x.start and y.start, respectively.

save.to.R

output the matrix of results for the upwind-ordered method to the current R session. The default is to write the matrix to the R session. save.to.R=FALSE prevents the output from being written to the R session.

save.to.HD

write the matrix of results for the upwind-ordered method to the hard drive named filename. Default is FALSE.

bounce

by default, the upwind-ordered method stops when the boundaries are reached. The bounce parameter allows the default action (bounce = 'd'), only positive values to be tested (bounce = 'p'), or reflection near the boundaries (bounce = 'b').

bounce.edge

if bounce = 'b', then to prevent the upwind-ordered method from reaching the boundaries, temporary boundaries are created inside the boundaries defined by x.bound and y.bound. The boundary edge is bounce.edge of the total range. Default is 0.01

verboseR

NOT IMPLEMENTED: Flag (default = FALSE) for printing out information in QPotential Rwrapper

verboseC

flag (default = TRUE) for printing out useful-for-everyone information in quasipotential.C

debugC

NOT IMPLEMENTED: Flag (default = FALSE) for printing out debugging C code

k.x

integer anisotropic factor for x. See journal article. Default is 20.

k.y

integer anisotropic factor for y. See journal article. Default is 20.

Value

• filetoHD if save.to.HD enabled, then saves a file in the current directory as either filename or as defaultname-xXSTARTyYSTART.txt

  filetoR if save.to.R enabled, then the function QPotential returns a matrix containing the upwind-ordered results to be used for plotting. Requires a variable to catch the returned matrix, i.e. storage <- QPotential(parameters...)

Examples

# First, System of equations
	equationx <- "1.54*x*(1.0-(x/10.14)) - (y*x*x)/(1.0+x*x)"
	equationy <- "((0.476*x*x*y)/(1+x*x)) - 0.112590*y*y"

# Second, shared parameters for each quasi-potential run
	xbounds <- c(-0.5, 8.0)
	ybounds <- c(-0.5, 8.0)
	xstepnumber <- 200
	ystepnumber <- 200

# Third, a local quasi-potential run
	xinit1 <- 1.40491
	yinit1 <- 2.80808
	storage.eq1 <- QPotential(x.rhs = equationx, x.start = xinit1,
		x.bound = xbounds, x.num.steps = xstepnumber, y.rhs = equationy,
		y.start = yinit1, y.bound = ybounds, y.num.steps = ystepnumber)