|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.sc.seis.TauP.VelocityModel
This class defines basic classes to store and manipulate a velocity model.
Field Summary | |
protected double |
cmbDepth
Depth (km) of the cmb (core mantle boundary). |
protected java.lang.String |
fileType
type of velocity file to be read in, either "nd" for named discontinuities or "tvel" for ttimes style files. |
protected double |
G
Not used, gravitational constant, default 6.67e-11 m^3 / kg s^2 |
protected double |
iocbDepth
Depth (km) of the iocb (inner core outer core boundary). |
protected java.util.Vector |
layer
expandable array to hold the layers |
protected double |
maxRadius
maximum radius of the model (km), default 6371.0 |
protected double |
meanDensity
Not used, mean Density (kg/m^3), default 5517.0 |
protected double |
minRadius
minimum radius of the model (km), default 0.0 |
protected java.lang.String |
modelName
name of the velocity model. |
protected double |
mohoDepth
Depth (km) of the moho. |
protected double |
radiusOfEarth
reference radius (km), usually radius of the earth, by default 6371 kilometers. |
protected boolean |
spherical
is this a spherical model? Default is true. |
protected static int |
vectorLength
the initial length of the layer vector. |
Constructor Summary | |
VelocityModel()
|
Method Summary | |
java.lang.Object |
clone()
|
double |
depthAtBottom(int layerNumber)
returns the depth at the bottom of the given layer. |
double |
depthAtTop(int layerNumber)
returns the depth at the top of the given layer. |
VelocityModel |
earthFlattenTransform()
Returns a flat velocity model object equivalent to the spherical velocity model via the earth flattening transform. |
double |
evaluateAbove(double depth,
char materialProperty)
returns the value of the given material property, usually P or S velocity, at the given depth. |
double |
evaluateAtBottom(int layerNumber,
char materialProperty)
returns the value of the given material property, usually P or S velocity, at the bottom of the given layer. |
double |
evaluateAtTop(int layerNumber,
char materialProperty)
returns the value of the given material property, usually P or S velocity, at the top of the given layer. |
double |
evaluateBelow(double depth,
char materialProperty)
returns the value of the given material property, usually P or S velocity, at the given depth. |
boolean |
fixDisconDepths()
resets depths of major discontinuities to match those existing in the input velocity model. |
double |
getCmbDepth()
|
double[] |
getDisconDepths()
|
double |
getG()
|
double |
getIocbDepth()
|
double |
getMaxRadius()
|
double |
getMeanDensity()
|
double |
getMinRadius()
|
java.lang.String |
getModelName()
get the model name. |
double |
getMohoDepth()
|
int |
getNumLayers()
Returns the number of layers in this velocity model. |
double |
getRadiusOfEarth()
gets radius of the earth (km), by default 6371 kilometers. |
boolean |
getSpherical()
|
VelocityLayer |
getVelocityLayer(int layerNum)
|
VelocityLayer |
getVelocityLayerClone(int layerNum)
|
int |
layerNumberAbove(double depth)
Finds the layer containing the given depth. |
int |
layerNumberBelow(double depth)
Finds the layer containing the given depth. |
static void |
main(java.lang.String[] args)
Just for debugging purposes. |
void |
print()
|
void |
printGMT(java.io.DataOutputStream dos)
prints out the velocity model into a file in a for suitable for plotting with GMT. |
void |
printGMT(java.lang.String filename)
prints out the velocity model into a file in a form suitable for plotting with GMT. |
void |
readCubicSplineFile(java.lang.String filename,
java.lang.String lookForModelName)
Reads in a cubic spline file, the original format of the ttimes code. |
void |
readNDFile(java.lang.String filename)
This method reads in a velocity model from a "nd" ASCII text file, the format used by Xgbm. |
void |
readTVelFile(java.lang.String filename)
This method reads in a velocity model from a "tvel" ASCII text file. |
void |
readVelocityFile(java.lang.String filename)
Reads in a velocity file. |
void |
replaceLayers(VelocityLayer[] newLayers,
boolean matchTop,
boolean matchBot)
|
void |
setCmbDepth(double cmbDepth)
|
void |
setFileType(java.lang.String fileType)
sets file type, either "nd" for named discontinuities or "tvel" for ttimes tvel models. |
void |
setG(double G)
|
void |
setIocbDepth(double iocbDepth)
|
void |
setMaxRadius(double maxRadius)
|
void |
setMeanDensity(double meanDensity)
|
void |
setMinRadius(double minRadius)
|
void |
setModelName(java.lang.String modelName)
set the model name. |
void |
setMohoDepth(double mohoDepth)
|
void |
setRadiusOfEarth(double radiusOfEarth)
sets radius of the earth (km), by default 6371 kilometers. |
void |
setSpherical(boolean spherical)
|
java.lang.String |
toString()
|
boolean |
validate()
Performs internal consistency checks on the velocity model. |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.lang.String modelName
protected java.lang.String fileType
protected double radiusOfEarth
protected double mohoDepth
protected double cmbDepth
protected double iocbDepth
protected double meanDensity
protected double G
protected double minRadius
protected double maxRadius
protected boolean spherical
protected static int vectorLength
protected java.util.Vector layer
Vector
,
VelocityLayer
Constructor Detail |
public VelocityModel()
Method Detail |
public java.lang.String getModelName()
public void setModelName(java.lang.String modelName)
public void setFileType(java.lang.String fileType)
public void setRadiusOfEarth(double radiusOfEarth)
public double getRadiusOfEarth()
public double[] getDisconDepths()
public double getMohoDepth()
public void setMohoDepth(double mohoDepth)
public double getCmbDepth()
public void setCmbDepth(double cmbDepth)
public double getIocbDepth()
public void setIocbDepth(double iocbDepth)
public double getMeanDensity()
public void setMeanDensity(double meanDensity)
public double getMinRadius()
public void setMinRadius(double minRadius)
public double getMaxRadius()
public void setMaxRadius(double maxRadius)
public double getG()
public void setG(double G)
public boolean getSpherical()
public void setSpherical(boolean spherical)
public VelocityLayer getVelocityLayerClone(int layerNum)
public VelocityLayer getVelocityLayer(int layerNum)
public int getNumLayers()
public int layerNumberAbove(double depth) throws NoSuchLayerException
NoSuchLayerException
- occurs if no layer contains the
given depth.public int layerNumberBelow(double depth) throws NoSuchLayerException
NoSuchLayerException
- occurs if no layer contains the
given depth.public double evaluateAbove(double depth, char materialProperty) throws NoSuchLayerException, NoSuchMatPropException
NoSuchLayerException
- occurs if no layer contains the given
depth.
NoSuchMatPropException
- occurs if the material
property is not recognized.public double evaluateBelow(double depth, char materialProperty) throws NoSuchLayerException, NoSuchMatPropException
NoSuchLayerException
- occurs if no layer contains the given
depth.
NoSuchMatPropException
- occurs if the material
property is not recognized.public double evaluateAtTop(int layerNumber, char materialProperty) throws NoSuchMatPropException
NoSuchMatPropException
- occurs if the material
property is not recognized.public double evaluateAtBottom(int layerNumber, char materialProperty) throws NoSuchMatPropException
NoSuchMatPropException
- occurs if the material
property is not recognized.public double depthAtTop(int layerNumber)
public double depthAtBottom(int layerNumber) throws NoSuchMatPropException
NoSuchMatPropException
- occurs if the material
property is not recognized.public void replaceLayers(VelocityLayer[] newLayers, boolean matchTop, boolean matchBot) throws NoSuchLayerException
NoSuchLayerException
public void printGMT(java.lang.String filename) throws java.io.IOException
java.io.IOException
public void printGMT(java.io.DataOutputStream dos) throws java.io.IOException
java.io.IOException
public boolean validate()
public java.lang.String toString()
public java.lang.Object clone()
public void print()
public void readVelocityFile(java.lang.String filename) throws java.io.IOException, VelocityModelException
VelocityModelException
- if the type of file cannot
be determined.
java.io.IOException
public void readCubicSplineFile(java.lang.String filename, java.lang.String lookForModelName) throws java.io.IOException
java.io.IOException
public void readTVelFile(java.lang.String filename) throws java.io.IOException, VelocityModelException
VelocityModelException
- occurs if an EOL should have been
read but wasn't. This may indicate a poorly formatted tvel file.
java.io.IOException
public void readNDFile(java.lang.String filename) throws java.io.IOException, VelocityModelException
VelocityModelException
- occurs if an EOL should have been
read but wasn't. This may indicate a poorly formatted model file.
java.io.IOException
public boolean fixDisconDepths()
public VelocityModel earthFlattenTransform() throws VelocityModelException
VelocityModelException
- occurs ???.public static void main(java.lang.String[] args)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |