spis.Util.Func
Class GradCosMultiD

java.lang.Object
  extended byspis.Util.Func.GradCosMultiD
All Implemented Interfaces:
VectFunctionOfVect

public class GradCosMultiD
extends java.lang.Object
implements VectFunctionOfVect

Class Name : GradCosMultiD
Project ref : SPIS project
File name : GradCosMultiD.java
File type : class
Copyright : ONERA, 2 Av. E. Belin, 31055 Toulouse cedex, France http://www.onecert.fr
Status : under development
Creation : Feb 6, 2004
Modification :

Description : Gradient of CodMultiD function.


Versions and anomalies correction :

Version numberAuthor (name, e-mail) Corrections/Modifications
0.1 JF Roussel, roussel@onecert.frCreation


Version:
0.1
Author:
JF Roussel

Field Summary
private  int dim
          Vector dimension
private  float[] k
          Wave number in each direction (k in cos(kx))
private  float norm
          Normalisation of the function
private  float[] phi
          Phase in each direction (phi in cos(kx+phi))
 
Constructor Summary
GradCosMultiD(int dimension, float[] waveNumber, float[] phase, float normalisation)
          Default constructor, sets parameters to define the function, the gradient of which will be computed:
(cos(kx+phix) * cos(ky+phiy) * cos(kz+phyz)...) * norm
with k=waveNumber, phi=phase, norm=normalisation (dim=3 in this expression).
 
Method Summary
 float[] vectComputeOfVect(float[] vect)
          Returns (cos(kx+phix) * cos(ky+phiy) * cos(kz+phyz)) * norm (and more if dim larger than 3), where vect = (x, y, z, ...)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

dim

private int dim
Vector dimension


k

private float[] k
Wave number in each direction (k in cos(kx))


phi

private float[] phi
Phase in each direction (phi in cos(kx+phi))


norm

private float norm
Normalisation of the function

Constructor Detail

GradCosMultiD

public GradCosMultiD(int dimension,
                     float[] waveNumber,
                     float[] phase,
                     float normalisation)
Default constructor, sets parameters to define the function, the gradient of which will be computed:
(cos(kx+phix) * cos(ky+phiy) * cos(kz+phyz)...) * norm
with k=waveNumber, phi=phase, norm=normalisation (dim=3 in this expression).

Method Detail

vectComputeOfVect

public float[] vectComputeOfVect(float[] vect)
Returns (cos(kx+phix) * cos(ky+phiy) * cos(kz+phyz)) * norm (and more if dim larger than 3), where vect = (x, y, z, ...)

Specified by:
vectComputeOfVect in interface VectFunctionOfVect