DTK_BasicGeometryEntityImpl.hpp

Go to the documentation of this file.

//---------------------------------------------------------------------------//
/*
  Copyright (c) 2012, Stuart R. Slattery
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
  met:

  *: Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

  *: 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.

  *: Neither the name of the University of Wisconsin - Madison nor the
  names of its contributors may be used to endorse or promote products
  derived from this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "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 THE COPYRIGHT
  HOLDER OR 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.
*/
//---------------------------------------------------------------------------//
//---------------------------------------------------------------------------//

#ifndef DTK_BASICGEOMETRYENTITYIMPL_HPP
#define DTK_BASICGEOMETRYENTITYIMPL_HPP

#include <iostream>

#include "DTK_BasicGeometryExtraData.hpp"
#include "DTK_EntityImpl.hpp"

#include <Teuchos_Array.hpp>
#include <Teuchos_ArrayView.hpp>
#include <Teuchos_Tuple.hpp>

namespace DataTransferKit
{
//---------------------------------------------------------------------------//
//---------------------------------------------------------------------------//
class BasicGeometryEntityImpl : public EntityImpl
{
  public:
    // Default constructor.
    BasicGeometryEntityImpl() { /* ... */}

    // Destructor.
    virtual ~BasicGeometryEntityImpl() { /* ... */}


    virtual EntityId id() const override = 0;

    virtual int ownerRank() const override = 0;

    virtual int topologicalDimension() const override = 0;

    virtual int physicalDimension() const override = 0;

    virtual void
    boundingBox( Teuchos::Tuple<double, 6> &bounds ) const override = 0;

    virtual bool inBlock( const int block_id ) const override = 0;

    virtual bool onBoundary( const int boundary_id ) const override = 0;

    virtual Teuchos::RCP<EntityExtraData> extraData() const override
    {
        return Teuchos::rcp( new BasicGeometryExtraData( this ) );
    }

    virtual std::string description() const override = 0;

    virtual void
    describe( Teuchos::FancyOStream &out,
              const Teuchos::EVerbosityLevel verb_level ) const override = 0;

    // Return the entity measure with respect to the parameteric
    virtual double measure() const = 0;

    // Compute the centroid of the entity.
    virtual void
    centroid( const Teuchos::ArrayView<double> &centroid ) const = 0;

    // (Reverse Map) Map a point to the reference space of an entity. Return
    // the parameterized point.
    virtual bool mapToReferenceFrame(
        const Teuchos::ArrayView<const double> &point,
        const Teuchos::ArrayView<double> &reference_point ) const = 0;

    // Determine if a reference point is in the parameterized space of an
    // entity.
    virtual bool checkPointInclusion(
        const double tolerance,
        const Teuchos::ArrayView<const double> &reference_point ) const = 0;

    // (Forward Map) Map a reference point to the physical space of an entity.
    virtual void
    mapToPhysicalFrame( const Teuchos::ArrayView<const double> &reference_point,
                        const Teuchos::ArrayView<double> &point ) const = 0;
};

//---------------------------------------------------------------------------//

} // end namespace DataTransferKit

#endif // end DTK_BASICGEOMETRYENTITYIMPL_HPP

//---------------------------------------------------------------------------//
// end DTK_BasicGeometryEntityImpl.hpp
//---------------------------------------------------------------------------//