/*
* OpenPixi - Open Particle-In-Cell (PIC) Simulator
* Copyright (C) 2012 OpenPixi.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package org.openpixi.pixi.ui.util;
import java.io.IOException;
import java.io.StringReader;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import javax.xml.parsers.ParserConfigurationException;
import java.lang.NumberFormatException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.Attributes;
import org.xml.sax.helpers.DefaultHandler;
import org.openpixi.pixi.physics.Settings;
import org.openpixi.pixi.physics.grid.*;
import org.openpixi.pixi.physics.solver.*;
import org.openpixi.pixi.diagnostics.methods.*;
/** @deprecated Use ui.util.YamlParser instead.*/
@Deprecated
public class Parser extends DefaultHandler {
SAXParserFactory factory;
Settings settings;
private boolean numberOfParticles;
private boolean simulationWidth;
private boolean simulationHeight;
private boolean timeStep;
private boolean interpolator;
private boolean particleMover;
private boolean diagnostics;
private boolean iterations;
private boolean runid;
private boolean simulationType;
private boolean writeToFile;
private String attribute = null;
public Parser(Settings settings) {
factory = SAXParserFactory.newInstance();
this.settings = settings;
}
/**
* Parse a file.
* @param path File path.
*/
public void parse(String path) {
try {
SAXParser parser = factory.newSAXParser();
parser.parse(path, this);
} catch (ParserConfigurationException e) {
System.out.println("ParserConfig error");
} catch (SAXException e) {
System.out.println("Parsing aborted!\n"
+ "Probably the xml file is not formated correctly!\n"
+ "Not all parameters were processed!");
} catch (IOException e) {
System.out.println("IO error! Settings file was not parsed!\n"
+ "Probably the settings file is missing or is in the wrong path!\n"
+ "Reverting to defaults...");
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* Parse a string directly.
* @param string String to be parsed.
*/
public void parseString(String string) {
InputSource is = new InputSource(new StringReader(string));
try {
SAXParser parser = factory.newSAXParser();
parser.parse(is, this);
} catch (ParserConfigurationException e) {
System.out.println("ParserConfig error");
} catch (SAXException e) {
System.out.println("Parsing aborted!\n"
+ "Probably the xml file is not formated correctly!\n"
+ "Not all parameters were processed!");
} catch (IOException e) {
System.out.println("IO error! Settings file was not parsed!\n"
+ "Probably the settings file is missing or is in the wrong path!\n"
+ "Reverting to defaults...");
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
public void startElement(String uri, String localName, String qName, Attributes attributes)
throws SAXException {
try {
if (qName.equalsIgnoreCase("numberOfParticles")) {
numberOfParticles = true;
} else if (qName.equalsIgnoreCase("simulationWidth")) {
simulationWidth = true;
} else if (qName.equalsIgnoreCase("simulationHeight")) {
simulationHeight = true;
} else if (qName.equalsIgnoreCase("timeStep")) {
timeStep = true;
} else if (qName.equalsIgnoreCase("interpolatorAlgorithm")) {
interpolator = true;
} else if (qName.equalsIgnoreCase("particleSolver")) {
particleMover = true;
} else if (qName.equalsIgnoreCase("diagnostics")) {
diagnostics = true;
try {
attribute = attributes.getValue(0);
} catch (Exception e) {
System.err.println("You need to specify a diagnostics interval (as an attribute)"
+ " for each diagnostic method you specify! Choose 0 if you only want it"
+ " to be performed at the beginning! Skipping those diagnostics where no"
+ " attributes were found.");
diagnostics = false;
}
} else if (qName.equalsIgnoreCase("iterations")) {
iterations = true;
} else if (qName.equalsIgnoreCase("runid")) {
runid = true;
} else if (qName.equalsIgnoreCase("simulationType")) {
simulationType = true;
} else if (qName.equalsIgnoreCase("writeToFile")) {
writeToFile = true;
} else if (qName.equalsIgnoreCase("settings")) {
//DO NOTHING
} else {
throw new Exception();
}
} catch (Exception e) {
System.out.println(qName + " can not be parsed!");
}
}
@Override
public void endElement(String uri, String localName, String qName) throws SAXException {
}
@Override
public void characters(char ch[], int start, int length) throws SAXException {
if (runid) {
setRunid(ch, start, length);
runid = false;
}
if (iterations) {
setIterations(ch, start, length);
iterations = false;
}
if (simulationType) {
setSimulationType(ch, start, length);
simulationType = false;
}
if (writeToFile) {
setWriteToFile(ch, start, length);
writeToFile = false;
}
if (numberOfParticles) {
setNumberOfParticles(ch, start, length);
numberOfParticles = false;
}
if (simulationWidth) {
setSimulationWidth(ch, start, length);
simulationWidth = false;
}
if (simulationHeight) {
setSimulationHeight(ch, start, length);
simulationHeight = false;
}
if (timeStep) {
setTimeStep(ch, start, length);
timeStep = false;
}
if (interpolator) {
setInterpolator(ch, start, length);
interpolator = false;
}
if (particleMover) {
setParticleSolver(ch, start, length);
particleMover = false;
}
if (diagnostics) {
addDiagnostics(ch, start, length);
diagnostics = false;
attribute = null;
}
}
private void setRunid(char ch[], int start, int length) {
settings.setRunid(new String(ch, start, length));
}
private void setIterations(char ch[], int start, int length) {
int n;
try {
n = Integer.parseInt(new String(ch, start, length));
if (n < 0) {
throw new NumberFormatException();
}
} catch (NumberFormatException e) {
System.out.println("Error: the number of iterations is not a positive integer! "
+ "Setting it to 100.");
n = 100;
}
settings.setIterations(n);
}
private void setSimulationType(char ch[], int start, int length) {
int simType;
String simtype = new String(ch, start, length);
try {
if (simtype.equalsIgnoreCase("Sequential")) {
simType = 0;
} else if (simtype.equalsIgnoreCase("Parallel")) {
simType = 1;
} else {
throw new Exception();
}
} catch (Exception e) {
System.out.println("Error: OpenPixi does not know about the " + simtype + " simulation type"
+ " . Setting it to Sequential.");
simType = 0;
}
settings.setSimulationType(simType);
}
private void setWriteToFile(char ch[], int start, int length) {
int writeTo;
String writeToFiles = new String(ch, start, length);
try {
if (writeToFiles.equalsIgnoreCase("No")) {
writeTo = 0;
} else if (writeToFiles.equalsIgnoreCase("Yes")) {
writeTo = 1;
} else {
throw new Exception();
}
} catch (Exception e) {
System.out.println("Error: OpenPixi does not know about the " + writeToFiles + " write to file option"
+ " . Setting it to No.");
writeTo = 0;
}
settings.setWriteToFile(writeTo);
}
private void addDiagnostics(char ch[], int start, int length) {
Diagnostics method;
String mtdname = new String(ch, start, length);
int n;
try {
n = Integer.parseInt(attribute);
if (n < 0) {
throw new NumberFormatException();
}
} catch (NumberFormatException e) {
System.err.println("Error: the interval you specified is not a positive integer! "
+ "Setting it to 0. The diagnostic will only be performed only at the beginning.");
n = 0;
}
try {
if (mtdname.equalsIgnoreCase("Kinetic Energy")) {
method = new KineticEnergy(n);
} else if (mtdname.equalsIgnoreCase("Potential")) {
method = new Potential(n);
} else {
throw new Exception();
}
} catch (Exception e) {
System.err.println("OpenPixi does not know about the " + mtdname + " diagnostic"
+ " method. Skipping this setting!");
return;
}
settings.getDiagnostics().add(method);
}
private void setNumberOfParticles(char ch[], int start, int length) {
int n;
try {
n = Integer.parseInt(new String(ch, start, length));
if (n < 0) {
throw new NumberFormatException();
}
} catch (NumberFormatException e) {
System.out.println("Error: particle number is not a positive integer! Setting n = 100.");
n = 100;
}
settings.setNumOfParticles(n);
}
private void setTimeStep(char ch[], int start, int length) {
double t;
try {
t = Double.parseDouble(new String(ch, start, length));
if (t < 0) {
throw new NumberFormatException();
}
} catch (NumberFormatException e) {
System.out.println("Error: time step is not a positive value! Setting it to 1.");
t = 1;
}
settings.setTimeStep(t);
}
private void setSimulationWidth(char ch[], int start, int length) {
double w;
try {
w = Double.parseDouble(new String(ch, start, length));
if (w < 0) {
throw new NumberFormatException();
}
} catch (NumberFormatException e) {
System.out.println("Error: simulation width is not a positive value! Setting it to 100.");
w = 100;
}
settings.setSimulationWidth(w);
}
private void setSimulationHeight(char ch[], int start, int length) {
double h;
try {
h = Double.parseDouble(new String(ch, start, length));
if (h < 0) {
throw new NumberFormatException();
}
} catch (NumberFormatException e) {
System.out.println("Error: simulation height is not a positive value! Setting it to 100.");
h = 100;
}
settings.setSimulationHeight(h);
}
private void setInterpolator(char ch[], int start, int length) {
InterpolatorAlgorithm alg;
String algname = new String(ch, start, length);
try {
if (algname.equalsIgnoreCase("Cloud In Cell")) {
alg = new CloudInCell();
} else if (algname.equalsIgnoreCase("Charge Conserving CIC")) {
alg = new ChargeConservingCIC();
} else {
throw new Exception();
}
} catch (Exception e) {
System.out.println("Error: OpenPixi does not know about the " + algname + " interpolation"
+ " algorithm. Setting it to CloudInCell.");
alg = new CloudInCell();
algname = "Cloud In Cell";
}
settings.setInterpolator(alg);
settings.setOCLGridInterpolator(algname);
}
private void setParticleSolver(char ch[], int start, int length) {
Solver alg;
String algname = new String(ch, start, length);
try {
if (algname.equalsIgnoreCase("Boris")) {
alg = new Boris();
} else if (algname.equalsIgnoreCase("Boris Damped")) {
alg = new BorisDamped();
} else if (algname.equalsIgnoreCase("Empty Solver")) {
alg = new EmptySolver();
} else if (algname.equalsIgnoreCase("Euler")) {
alg = new Euler();
} else if (algname.equalsIgnoreCase("Euler Richardson")) {
alg = new EulerRichardson();
} else if (algname.equalsIgnoreCase("Leap Frog")) {
alg = new LeapFrog();
} else if (algname.equalsIgnoreCase("Leap Frog Damped")) {
alg = new LeapFrogDamped();
} else if (algname.equalsIgnoreCase("Leap Frog Half Step")) {
alg = new LeapFrogHalfStep();
} else if (algname.equalsIgnoreCase("SemiImplicit Euler")) {
alg = new SemiImplicitEuler();
} else if (algname.equalsIgnoreCase("Boris Profile")) {
alg = new Boris();
} else {
throw new Exception();
}
} catch (Exception e) {
System.out.println("Error: OpenPixi does not know about the " + algname + " solver"
+ " mover. Setting it to Boris.");
alg = new Boris();
algname = "Boris";
}
settings.setParticleSolver(alg);
settings.setOCLParticleSolver(algname);
}
}