RTOpPack::SUNDIALS_VConstrMask< Scalar > Class Template Reference

#include <RTOpPack_SUNDIALS_Ops.hpp>

Inheritance diagram for RTOpPack::SUNDIALS_VConstrMask< Scalar >:

[legend]
List of all members.

Overridden from RTOpT

void apply_op (const int num_vecs, const ConstSubVectorView< Scalar > sub_vecs[], const int num_targ_vecs, const SubVectorView< Scalar > targ_sub_vecs[], ReductTarget *reduct_obj) const
 

Public Member Functions

 SUNDIALS_VConstrMask ()
 

Detailed Description

template<class Scalar>
class RTOpPack::SUNDIALS_VConstrMask< Scalar >

Performs the operation :
       m[i] = 1.0 if constraint test fails for x[i]
       m[i] = 0.0 if constraint test passes for x[i]
where the constraint tests are as follows:
      If c[i] = +2.0, then x[i] must be >  0.0.
      If c[i] = +1.0, then x[i] must be >= 0.0.
      If c[i] = -1.0, then x[i] must be <= 0.0.
      If c[i] = -2.0, then x[i] must be <  0.0.
This routine returns a boolean FALSE if any element failed the constraint test, TRUE if all passed. It also sets a mask vector m, with elements equal to 1.0 where the corresponding constraint test failed, and equal to 0.0 where the constraint test passed. This routine is specialized in that it is used only for constraint checking.

Author:
K. Long

Definition at line 383 of file RTOpPack_SUNDIALS_Ops.hpp.


Constructor & Destructor Documentation

template<class Scalar>
RTOpPack::SUNDIALS_VConstrMask< Scalar >::SUNDIALS_VConstrMask  )  [inline]
 

Definition at line 388 of file RTOpPack_SUNDIALS_Ops.hpp.


Member Function Documentation

template<class Scalar>
void RTOpPack::SUNDIALS_VConstrMask< Scalar >::apply_op const int  num_vecs,
const ConstSubVectorView< Scalar >  sub_vecs[],
const int  num_targ_vecs,
const SubVectorView< Scalar >  targ_sub_vecs[],
ReductTarget reduct_obj
const [inline, virtual]
 

Implements RTOpPack::RTOpT< Scalar >.

Definition at line 396 of file RTOpPack_SUNDIALS_Ops.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:30:44 2008 for RTOp Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1