SundanceMapStructure.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_MAPSTRUCTURE_H
#define SUNDANCE_MAPSTRUCTURE_H


#include "SundanceDefs.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_RefCountPtr.hpp"

namespace Sundance
{
using namespace Teuchos;

class BasisDOFTopologyBase;

/** 
 * 
 */
class MapStructure
{
public:
  /** */
  MapStructure(int nTotalFuncs,
    const Array<RCP<BasisDOFTopologyBase> >& bases,
    const Array<Array<int> >& funcs);
  /** */
  MapStructure(int nTotalFuncs,
    const RCP<BasisDOFTopologyBase>& basis,
    const Array<Array<int> >& funcs);
  /** */
  MapStructure(int nTotalFuncs,
    const RCP<BasisDOFTopologyBase>& basis);

  /** */
  int numBasisChunks() const {return bases_.size();}

  /** */
  const RCP<BasisDOFTopologyBase>& basis(int basisChunk) const
    {return bases_[basisChunk];}

  /** */
  int numFuncs(int basisChunk) const 
    {return funcs_[basisChunk].size();}

  /** */
  const Array<int>& funcs(int basisChunk) const 
    {return funcs_[basisChunk];}

  /** */
  int chunkForFuncID(int funcID) const ;

  /** */
  int indexForFuncID(int funcID) const ;

  /** */
  std::ostream& print(std::ostream& os) const ;

private:
  /** */
  void init(int nTotalFuncs,
    const Array<RCP<BasisDOFTopologyBase> >& bases,
    const Array<Array<int> >& funcs);

  Array<RCP<BasisDOFTopologyBase> > bases_;
  Array<Array<int> > funcs_;
  Array<int> chunkForFuncID_;
  Array<int> indexForFuncID_;
};

/** \relates BasisDOFTopologyBase */
Array<RCP<BasisDOFTopologyBase> > replicate(
  const RCP<BasisDOFTopologyBase>& model,
  int n);



/** \relates MapStructure */
inline std::ostream& operator<<(std::ostream& os,
  const MapStructure& m)
{
  return m.print(os);
}

}
#endif