Package de.jtem.jpetsc

This package makes a part of the functionality of the numeric library PETSc accessible for Java programs.

See:
          Description

Interface Summary
MPIDistributable  
MPIRunnable  
MPIRunnAndSerializable  
SNES.Application  
SNES.FunctionEvaluator  
SNES.JacobianEvaluator  
 

Class Summary
KSP  
KSP.ComputeEigenvaluesExplicitlyResult Result class for KSP.computeEigenvaluesExplicitly(int)
KSP.ComputeEigenvaluesResult Result class for KSP.computeEigenvalues(int)
KSP.ComputeExtremeSingularValuesResult Result class for KSP.computeExtremeSingularValues()
KSP.GetOperatorsResult Result class for KSP.getOperators()
KSP.GetOperatorsSetResult Result class for KSP.getOperatorsSet()
KSP.GetTolerancesResult Result class for KSP.getTolerances()
Mat  
Mat.CreateCompositeResult Result class for Mat.createComposite(int, int)
Mat.GetInertiaResult Result class for Mat.getInertia()
Mat.GetLocalSizeResult Result class for Mat.getLocalSize()
Mat.GetOwnershipRangeResult Result class for Mat.getOwnershipRange()
Mat.GetSizeResult Result class for Mat.getSize()
Mat.GetVecsResult Result class for Mat.getVecs()
Mat.IsHermitianKnownResult Result class for Mat.isHermitianKnown()
Mat.IsSymmetricKnownResult Result class for Mat.isSymmetricKnown()
Mat.StashGetInfoResult Result class for Mat.stashGetInfo()
MPI  
MPI.TestanyResult Result class for MPI.testany(int, int[], de.jtem.jpetsc.MPIStatus)
MPIStatus  
Native Common parent of PrimitvNatives that always create their native Object when they are created, without any further information.
PETSc  
PETSc.OptionsGetEListResult Result class for PETSc.optionsGetEList(java.lang.String, java.lang.String, int)
PETSc.OptionsGetIntResult Result class for PETSc.optionsGetInt(java.lang.String, java.lang.String)
PETSc.OptionsGetRealResult Result class for PETSc.optionsGetReal(java.lang.String, java.lang.String)
PETSc.OptionsGetScalarResult Result class for PETSc.optionsGetScalar(java.lang.String, java.lang.String)
PETSc.OptionsGetTruthResult Result class for PETSc.optionsGetTruth(java.lang.String, java.lang.String)
PrimitivNative Common parent of classes that have a corresponding native class.
SNES  
SNES.KSPGetParametersEWResult Result class for SNES.kSPGetParametersEW()
Vec  
Vec.GetOwnershipRangeResult Result class for Vec.getOwnershipRange()
Vec.MaxResult Result class for Vec.max()
Vec.MinResult Result class for Vec.min()
Vec.StashGetInfoResult Result class for Vec.stashGetInfo()
Vec.StrideMaxAllResult Result class for Vec.strideMaxAll()
Vec.StrideMaxResult Result class for Vec.strideMax(int)
Vec.StrideMinAllResult Result class for Vec.strideMinAll()
Vec.StrideMinResult Result class for Vec.strideMin(int)
 

Enum Summary
InsertMode  
KSPConvergedReason  
KSPNormType  
MatAssemblyType  
MatDuplicateOption  
MatStructure  
NormType  
SNESConvergedReason  
 

Error Summary
PETScError  
 

Package de.jtem.jpetsc Description

This package makes a part of the functionality of the numeric library PETSc accessible for Java programs. It utilizes the JNI to achieve that.

What it can

At the moment it is possible

What it can't


How to use

It's similar to PETSc

The names of the classes (= structures in c) and methods are the same (only adapted to Java naming conventions) and especially the functionality of the methods are at least hoped to be the same. Functions that belong logically to some structure (e.g. Vec or Mat) in both libraries carry the structure Name as Prefix (e.g. MatGetSize). That prefix is stripped off for those functions, that become members of the corresponding class the same time.

Some further differences are necessary

Because of the different natures of c and java mainly two big changes to the API were necessary: To give an example for these changes let's look at the following c prototype:

        PetscErrorCode MatGetSize(Mat mat,PetscInt *m,PetscInt* n);
                
it is translated to java to the following Mat class's members:

        public static class GetSizeResult {
                public final int m;
                public final int n;
        }

        public native GetSizeResult getSize();
                

Examples

see the corresponding section of the jTao project's documentation.