JaRMoS  1.1
Java Reduced Model Simulations
 All Classes Namespaces Files Functions Variables Enumerator Groups Pages
rb.affinefcn.IAffineFunctions Interface Reference

Base interface for any affine functions used as an externally loaded class. More...

Inheritance diagram for rb.affinefcn.IAffineFunctions:
models.rbm_advec.AffineFunctions models.rbm_advec_cheatbase.AffineFunctions models.rbm_advec_tc.AffineFunctions rb.affinefcn.rbappmitAffineFunctions

Public Member Functions

boolean isTimeDependentL ()
 Flag that indicates whether the output functional affine theta coefficient functions are time dependent or not. More...
 
boolean isTimeDependentA ()
 Flag that tells JRB if the bilinear form/input functional affine theta coefficient functions are time-dependent or not. More...
 
int[] getQl ()
 Returns the size of the affine linear combination for each output functional. More...
 
int getNumOutputs ()
 Returns the number of output functionals. More...
 
double thetaQl (int k, int i, double[] p, double t)
 Evaluates ^{q_l}_i for the output q_l and the current parameter p. More...
 
int getQf ()
 Gets the number of input functionals in the affine expansion. More...
 
double thetaQf (int i, double[] p, double t)
 Evaluates ^f_i for the current parameter p. More...
 
int getQa ()
 Gets the number of bilinear forms in the affine expansion. More...
 
double thetaQa (int i, double[] p, double t)
 Evaluates ^a_i for the current parameter p. More...
 

Detailed Description

Base interface for any affine functions used as an externally loaded class.

Todo:
generalize/separate to single IAffineCoefficients-Interface of JaRMoSBase
Author
Daniel Wirtz
Date
Aug 28, 2011

Definition at line 12 of file IAffineFunctions.java.

Member Function Documentation

int rb.affinefcn.IAffineFunctions.getNumOutputs ( )

Returns the number of output functionals.

Returns
The number of output functionals

Implemented in rb.affinefcn.rbappmitAffineFunctions, models.rbm_advec_tc.AffineFunctions, models.rbm_advec.AffineFunctions, and models.rbm_advec_cheatbase.AffineFunctions.

int rb.affinefcn.IAffineFunctions.getQa ( )

Gets the number of bilinear forms in the affine expansion.

Returns
The number of bilinear forms in the affine expansion.

Implemented in rb.affinefcn.rbappmitAffineFunctions, models.rbm_advec.AffineFunctions, models.rbm_advec_cheatbase.AffineFunctions, and models.rbm_advec_tc.AffineFunctions.

int rb.affinefcn.IAffineFunctions.getQf ( )

Gets the number of input functionals in the affine expansion.

Returns
The number of input functionals in the affine expansion.

Implemented in rb.affinefcn.rbappmitAffineFunctions, models.rbm_advec.AffineFunctions, models.rbm_advec_cheatbase.AffineFunctions, and models.rbm_advec_tc.AffineFunctions.

int [] rb.affinefcn.IAffineFunctions.getQl ( )

Returns the size of the affine linear combination for each output functional.

Returns
Ql for output functional "output_number"

Implemented in rb.affinefcn.rbappmitAffineFunctions, models.rbm_advec.AffineFunctions, models.rbm_advec_cheatbase.AffineFunctions, and models.rbm_advec_tc.AffineFunctions.

boolean rb.affinefcn.IAffineFunctions.isTimeDependentA ( )

Flag that tells JRB if the bilinear form/input functional affine theta coefficient functions are time-dependent or not.

The time parameter has to be passed every time anyways, but computations can be made mode efficient if the matrices stay identical for all time-steps

Returns
Whether ^a are time-dependent or not.

Implemented in rb.affinefcn.rbappmitAffineFunctions, models.rbm_advec.AffineFunctions, models.rbm_advec_cheatbase.AffineFunctions, and models.rbm_advec_tc.AffineFunctions.

boolean rb.affinefcn.IAffineFunctions.isTimeDependentL ( )

Flag that indicates whether the output functional affine theta coefficient functions are time dependent or not.

The time parameter has to be passed every time anyways, but computations can be made mode efficient if the matrices stay identical for all time-steps

Returns
Whether ^l are time-dependent or not.

Implemented in rb.affinefcn.rbappmitAffineFunctions, models.rbm_advec.AffineFunctions, models.rbm_advec_cheatbase.AffineFunctions, and models.rbm_advec_tc.AffineFunctions.

double rb.affinefcn.IAffineFunctions.thetaQa ( int  i,
double[]  p,
double  t 
)

Evaluates ^a_i for the current parameter p.

Parameters
iThe bilinar form i
pThe current parameter
tThe current time t
Returns
The value of ^a_i at (p,t)

Implemented in rb.affinefcn.rbappmitAffineFunctions, models.rbm_advec_tc.AffineFunctions, models.rbm_advec.AffineFunctions, and models.rbm_advec_cheatbase.AffineFunctions.

double rb.affinefcn.IAffineFunctions.thetaQf ( int  i,
double[]  p,
double  t 
)

Evaluates ^f_i for the current parameter p.

Parameters
iThe coefficient function i
pThe current parameter
tThe current time
Returns
The value of ^f_i at (p,t)

Implemented in rb.affinefcn.rbappmitAffineFunctions, models.rbm_advec.AffineFunctions, models.rbm_advec_cheatbase.AffineFunctions, and models.rbm_advec_tc.AffineFunctions.

double rb.affinefcn.IAffineFunctions.thetaQl ( int  k,
int  i,
double[]  p,
double  t 
)

Evaluates ^{q_l}_i for the output q_l and the current parameter p.

Parameters
kThe output index
iThe number of the function
pThe current parameter
tThe current time
Returns
The value of ^l_i at (p,t) for output k

Implemented in models.rbm_advec.AffineFunctions, models.rbm_advec_cheatbase.AffineFunctions, rb.affinefcn.rbappmitAffineFunctions, and models.rbm_advec_tc.AffineFunctions.


The documentation for this interface was generated from the following file: