PolynomialStructure

java.lang.Object
- io.github.kensuke1984.kibrary.dsminformation.PolynomialStructure

すべての実装されたインタフェース:

java.io.Serializable
```
public class PolynomialStructure
extends java.lang.Object
implements java.io.Serializable
```
(input) Structure of the Earth for softwares of Direct Solution Method (DSM)

Every depth is written in radius.

This class is IMMUTABLE

When you try to get values on radius of boundaries, you will get one in the isShallower layer, i.e., the layer which has the radius as rmin.

関連項目:

直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static PolynomialStructure`	`AK135` AK135 by Kennett et al. (1995)
`static PolynomialStructure`	`ISO_PREM` isotropic PREM by Dziewonski & Anderson 1981
`static PolynomialStructure`	`PREM` transversely isotropic (TI) PREM by Dziewonski & Anderson 1981

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

PolynomialStructure(java.nio.file.Path structurePath)

コンストラクタ
コンストラクタと説明
`PolynomialStructure(java.nio.file.Path structurePath)`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`PolynomialStructure`	`addBoundaries(double... radii)` 半径boundariesのところに境界を作る（層を一つ増やす） Add boundaries at the input radii.
`double`	`computeLambda(double r)`
`double`	`computeMu(double r)`
`double`	`computeVs(double r)` (2L+N)/(3ρ)
`double`	`computeXi(double r)`
`org.apache.commons.math3.analysis.polynomials.PolynomialFunction`	`createFunction(int n, double[] radii, double[] values)` The numbers of radii and values must be same.
`boolean`	`equals(java.lang.Object obj)`
`int`	`getCoreZone()`
`double`	`getEtaAt(double r)`
`int`	`getNzone()`
`double`	`getQkappaAt(double r)`
`double`	`getQmuAt(double r)`
`double`	`getQMuOf(int i)`
`double`	`getRhoAt(double r)`
`double`	`getRMaxOf(int izone)`
`double`	`getRMinOf(int izone)`
`double`	`getTransverselyIsotropicValue(TransverselyIsotropicParameter ti, double r)`
`double`	`getVphAt(double r)`
`org.apache.commons.math3.analysis.polynomials.PolynomialFunction`	`getVphOf(int izone)`
`double`	`getVpvAt(double r)`
`org.apache.commons.math3.analysis.polynomials.PolynomialFunction`	`getVpvOf(int izone)`
`double`	`getVshAt(double r)`
`org.apache.commons.math3.analysis.polynomials.PolynomialFunction`	`getVshOf(int izone)`
`double`	`getVsvAt(double r)`
`org.apache.commons.math3.analysis.polynomials.PolynomialFunction`	`getVsvOf(int izone)`
`int`	`hashCode()`
`static void`	`main(java.lang.String[] args)`
`PolynomialStructure`	`setQMu(int izone, double qMu)`
`PolynomialStructure`	`setVs(int izone, org.apache.commons.math3.analysis.polynomials.PolynomialFunction polynomialFunction)`
`PolynomialStructure`	`setVsh(int izone, org.apache.commons.math3.analysis.polynomials.PolynomialFunction polynomialFunction)`
`PolynomialStructure`	`setVsv(int izone, org.apache.commons.math3.analysis.polynomials.PolynomialFunction polynomialFunction)`
`java.lang.String[]`	`toPSVlines()`
`java.lang.String[]`	`toSHlines()`
`void`	`writePSV(java.nio.file.Path outPath, java.nio.file.OpenOption... options)`
`void`	`writeSH(java.nio.file.Path outPath, java.nio.file.OpenOption... options)`
`int`	`zoneOf(double r)`

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - PREM
```
public static final PolynomialStructure PREM
```
    transversely isotropic (TI) PREM by Dziewonski & Anderson 1981
  - ISO_PREM
```
public static final PolynomialStructure ISO_PREM
```
    isotropic PREM by Dziewonski & Anderson 1981
  - AK135
```
public static final PolynomialStructure AK135
```
    AK135 by Kennett et al. (1995)
- コンストラクタの詳細
  - PolynomialStructure
```
public PolynomialStructure(java.nio.file.Path structurePath)
                    throws java.io.IOException
```
    パラメータ:
    
    structurePath - Path of a
    
    例外:
    
    java.io.IOException - if an I/O error occurs. A structure file (structurePath) must exist.
- メソッドの詳細
  - main
```
public static void main(java.lang.String[] args)
                 throws java.io.IOException
```
    例外:
    
    java.io.IOException
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    オーバーライド:
    
    equals クラス内 java.lang.Object
  - getCoreZone
```
public int getCoreZone()
```
    戻り値:
    
    Number of core zones.
  - computeVs
```
public double computeVs(double r)
```
    (2L+N)/(3ρ)
    
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    effective isotropic shear wave velocity
  - computeXi
```
public double computeXi(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    ξ (N/L)
  - addBoundaries
```
public PolynomialStructure addBoundaries(double... radii)
```
    半径boundariesのところに境界を作る（層を一つ増やす） Add boundaries at the input radii. if there is already a boundary at r then nothing will be done.
    
    パラメータ:
    
    radii - radii for boundaries. Values smaller than 0 or bigger than earth radius will be ignored
    
    戻り値:
    
    a new structure which have additional layers at the input boundaries or this if there all the radiuses already exist in this
  - getTransverselyIsotropicValue
```
public double getTransverselyIsotropicValue(TransverselyIsotropicParameter ti,
                                            double r)
```
  - computeMu
```
public double computeMu(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    μ computed by Vs * Vs * ρ
  - computeLambda
```
public double computeLambda(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    λ computed by Vs * Vs * ρ
  - getNzone
```
public int getNzone()
```
    戻り値:
    
    number of zones
  - getQMuOf
```
public double getQMuOf(int i)
```
    パラメータ:
    
    i - index of a zone
    
    戻り値:
    
    Q_μ of the zone
  - setVsv
```
public PolynomialStructure setVsv(int izone,
                                  org.apache.commons.math3.analysis.polynomials.PolynomialFunction polynomialFunction)
```
  - setVsh
```
public PolynomialStructure setVsh(int izone,
                                  org.apache.commons.math3.analysis.polynomials.PolynomialFunction polynomialFunction)
```
  - setVs
```
public PolynomialStructure setVs(int izone,
                                 org.apache.commons.math3.analysis.polynomials.PolynomialFunction polynomialFunction)
```
  - setQMu
```
public PolynomialStructure setQMu(int izone,
                                  double qMu)
```
  - getRMinOf
```
public double getRMinOf(int izone)
```
    パラメータ:
    
    izone - index of the zone
    
    戻り値:
    
    minimum radius of the zone
  - getRMaxOf
```
public double getRMaxOf(int izone)
```
    パラメータ:
    
    izone - index of a zone
    
    戻り値:
    
    maximum radius of the zone
  - getRhoAt
```
public double getRhoAt(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    ρ at the radius r
  - getVpvAt
```
public double getVpvAt(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    V_PV at the radius r
  - getVphAt
```
public double getVphAt(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    V_PH at the radius r
  - getVsvAt
```
public double getVsvAt(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    V_SV at the radius r
  - getVshAt
```
public double getVshAt(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    V_SH at the radius r
  - getEtaAt
```
public double getEtaAt(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    η at the radius r
  - getQmuAt
```
public double getQmuAt(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    Q_μ at the radius r
  - getQkappaAt
```
public double getQkappaAt(double r)
```
    パラメータ:
    
    r - [km] radius
    
    戻り値:
    
    Q_κ at the radius r
  - zoneOf
```
public int zoneOf(double r)
```
    パラメータ:
    
    r - [km] radius [0, rmax]
    
    戻り値:
    
    the number of the zone which includes r. Note that the zone will be rmin ≤ r < rmax except r = earth radius
  - createFunction
```
public org.apache.commons.math3.analysis.polynomials.PolynomialFunction createFunction(int n,
                                                                                       double[] radii,
                                                                                       double[] values)
```
    The numbers of radii and values must be same.
    
    パラメータ:
    
    n - order of polynomial function. 0: constant, 1:linear function, 2:quadratic, 3: cubic
    
    radii - [km] radius
    
    values - values
    
    戻り値:
    
    PolynomialFunction for the input
  - toSHlines
```
public java.lang.String[] toSHlines()
```
  - toPSVlines
```
public java.lang.String[] toPSVlines()
```
  - writePSV
```
public void writePSV(java.nio.file.Path outPath,
                     java.nio.file.OpenOption... options)
              throws java.io.IOException
```
    パラメータ:
    
    outPath - Path of an write file.
    
    options - for write
    
    例外:
    
    java.io.IOException - if an I/O error occurs
  - writeSH
```
public void writeSH(java.nio.file.Path outPath,
                    java.nio.file.OpenOption... options)
             throws java.io.IOException
```
    パラメータ:
    
    outPath - Path of an write file.
    
    options - for write
    
    例外:
    
    java.io.IOException - if an I/O error occurs
  - getVpvOf
```
public org.apache.commons.math3.analysis.polynomials.PolynomialFunction getVpvOf(int izone)
```
    パラメータ:
    
    izone - index of a zone
    
    戻り値:
    
    polynomial function for V_PV of the zone
  - getVphOf
```
public org.apache.commons.math3.analysis.polynomials.PolynomialFunction getVphOf(int izone)
```
    パラメータ:
    
    izone - index of a zone
    
    戻り値:
    
    polynomial function for V_PH of the zone
  - getVsvOf
```
public org.apache.commons.math3.analysis.polynomials.PolynomialFunction getVsvOf(int izone)
```
    パラメータ:
    
    izone - index of a zone
    
    戻り値:
    
    polynomial function for V_SV of the zone
  - getVshOf
```
public org.apache.commons.math3.analysis.polynomials.PolynomialFunction getVshOf(int izone)
```
    パラメータ:
    
    izone - index of a zone
    
    戻り値:
    
    polynomial function for V_SH of the zone

クラス PolynomialStructure

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

PREM

ISO_PREM

AK135

コンストラクタの詳細

PolynomialStructure

メソッドの詳細

main

hashCode

equals

getCoreZone

computeVs

computeXi

addBoundaries

getTransverselyIsotropicValue

computeMu

computeLambda

getNzone

getQMuOf

setVsv

setVsh

setVs

setQMu

getRMinOf

getRMaxOf

getRhoAt

getVpvAt

getVphAt

getVsvAt

getVshAt

getEtaAt

getQmuAt

getQkappaAt

zoneOf

createFunction

toSHlines

toPSVlines

writePSV

writeSH

getVpvOf

getVphOf

getVsvOf

getVshOf