SundanceLocalMatrixContainer.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                             Sundance
//                 Copyright 2011 Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Kevin Long (kevin.long@ttu.edu)
// 

/* @HEADER@ */

#ifndef SUNDANCE_LOCALMATRIXCONTAINER_H
#define SUNDANCE_LOCALMATRIXCONTAINER_H

#include "SundanceDefs.hpp"
#include "SundanceDOFMapBuilder.hpp"

namespace Sundance
{
/** 
 * LocalMatrixContainer is a container for local matrix and vector values.
 * Local matrices and vectors are stored in identical ways: as 1D arrays
 * of doubles. toi
 *
 * Each integrator gets its own LocalMatrixContainer object, with information on
 * term grouping specific to the terms handled by that integrator. To conserve
 * memory, all LocalMatrixContainer objects share a common pool of data vectors. After 
 * insertion, the common pool can be reused in the next integration. It is the 
 * responsibility of the integrator to zero out and resize each data vector
 * as needed.
 *   
 * To leave the system as flexible as possible, this class does not specify
 * anything about the ordering of elements in the matrix. It is the
 * responsibility of the integrator and inserter classes to use a consistent
 * ordering. Different integrator-inserter combinations may well use different
 * orderings.
 *
 * It is often the case that several terms in a PDE will yield local 
 * matrices that have the same values, perhaps differing by a constant, 
 * but which are associated with different test and unknown functions. For this reason,
 * each batch of local matrix values has associated with it arrays
 * of (test, unk) pairs and coefficients.  
 */
class LocalMatrixContainer
{
public:
  /** */
  LocalMatrixContainer(const Array<int>& isTwoForm,
    const Array<Array<int> >& testID,
    const Array<Array<int> >& unkID,
    const Array<Array<double> >& coeffs);

  /** Return the data vector for the i-th batch */
  const RCP<Array<double> >& dataVector(int i) const 
    {return workspace()[i];}

  /** Indicate whether the i-th batch is a two form */
  bool isTwoForm(int i) const {return isTwoForm_[i];}

  /** Return the array of testIDs whose local matrix values are grouped int
   * the i-th batch */
  const Array<int>& testID(int i) const {return testID_[i];}

  /** Return the array of unkIDs whose local matrix values are grouped int
   * the i-th batch */
  const Array<int>& unkID(int i) const {return unkID_[i];}

  /** Return the array of coefficients to be used with the i-th batch */
  const Array<double>& coeffs(int i) const {return coeffs_[i];}

private:
      
  /** */
  static Array<RCP<Array<double> > >& workspace() 
    {static Array<RCP<Array<double> > > rtn; return rtn;}

  /** */
  Array<int> isTwoForm_;

  /** */
  Array<Array<int> > testID_;

  /** */
  Array<Array<int> > unkID_;

  /** */
  Array<Array<double> > coeffs_;
};
}



#endif