DTK_STKMeshManager.hpp

//---------------------------------------------------------------------------//
/*
  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_STKMESHMANAGER_HPP
#define DTK_STKMESHMANAGER_HPP

#include <string>
#include <unordered_map>

#include "DTK_ClientManager.hpp"
#include "DTK_DBC.hpp"
#include "DTK_Field.hpp"
#include "DTK_FieldMultiVector.hpp"
#include "DTK_FunctionSpace.hpp"
#include "DTK_STKMeshField.hpp"
#include "DTK_Types.hpp"

#include <Teuchos_Array.hpp>
#include <Teuchos_RCP.hpp>

#include <stk_mesh/base/BulkData.hpp>
#include <stk_mesh/base/Selector.hpp>

namespace DataTransferKit
{
//---------------------------------------------------------------------------//
//---------------------------------------------------------------------------//
class STKMeshManager : public ClientManager
{
  public:
    enum BasisType
    {
        BASIS_TYPE_GRADIENT
    };

  public:
    STKMeshManager( const Teuchos::RCP<stk::mesh::BulkData> &bulk_data,
                    const BasisType basis_type = BASIS_TYPE_GRADIENT );

    STKMeshManager( const Teuchos::RCP<stk::mesh::BulkData> &bulk_data,
                    const Teuchos::Array<std::string> &part_names,
                    const BasisType basis_type = BASIS_TYPE_GRADIENT );

    STKMeshManager( const Teuchos::RCP<stk::mesh::BulkData> &bulk_data,
                    const stk::mesh::PartVector &parts,
                    const BasisType basis_type = BASIS_TYPE_GRADIENT );

    STKMeshManager( const Teuchos::RCP<stk::mesh::BulkData> &bulk_data,
                    const stk::mesh::Selector &selector,
                    const BasisType basis_type = BASIS_TYPE_GRADIENT );

    template <class FieldType>
    void registerField( const Teuchos::Ptr<FieldType> &field,
                        const int field_dim );

    Teuchos::RCP<FunctionSpace> functionSpace() const;

    template <class FieldType>
    Teuchos::RCP<FieldMultiVector>
    createFieldMultiVector( const Teuchos::Ptr<FieldType> &field,
                            const int field_dim );


    Teuchos::RCP<EntitySet> entitySet() const override;

    Teuchos::RCP<EntityLocalMap> localMap() const override;

    Teuchos::RCP<EntityShapeFunction> shapeFunction() const override;

    Teuchos::RCP<EntityIntegrationRule> integrationRule() const override;

    PredicateFunction selectFunction() const override;

    Teuchos::RCP<Field> field( const std::string &field_name ) const override;

  private:
    // Create the function space.
    void createFunctionSpace( const BasisType basis_type,
                              const PredicateFunction &select_function );

  private:
    // Bulk data.
    Teuchos::RCP<stk::mesh::BulkData> d_bulk_data;

    // The function space over which the mesh and its fields are defined.
    Teuchos::RCP<FunctionSpace> d_function_space;

    // Field name to local id indexer.
    std::unordered_map<std::string, int> d_field_indexer;

    // Registered fields.
    Teuchos::Array<Teuchos::RCP<Field>> d_fields;
};

//---------------------------------------------------------------------------//
// Template functions.
//---------------------------------------------------------------------------//
template <class FieldType>
Teuchos::RCP<FieldMultiVector>
STKMeshManager::createFieldMultiVector( const Teuchos::Ptr<FieldType> &field,
                                        const int field_dim )
{
    DTK_REQUIRE( Teuchos::nonnull( d_bulk_data ) );
    DTK_REQUIRE( Teuchos::nonnull( d_function_space ) );

    Teuchos::RCP<Field> stk_field = Teuchos::rcp(
        new STKMeshField<double, FieldType>( d_bulk_data, field, field_dim ) );
    return Teuchos::rcp(
        new FieldMultiVector( stk_field, d_function_space->entitySet() ) );
}

//---------------------------------------------------------------------------//
template <class FieldType>
void STKMeshManager::registerField( const Teuchos::Ptr<FieldType> &field,
                                    const int field_dim )
{
    DTK_REQUIRE( Teuchos::nonnull( d_bulk_data ) );
    DTK_REQUIRE( Teuchos::nonnull( d_function_space ) );

    d_field_indexer.emplace( field->name(), d_fields.size() );

    d_fields.push_back( Teuchos::rcp( new STKMeshField<double, FieldType>(
        d_bulk_data, field, field_dim ) ) );
}

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

} // end namespace DataTransferKit

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

#endif // end DTK_STKMESHMANAGER_HPP

//---------------------------------------------------------------------------//
// end DTK_STKMeshManager.hpp
//---------------------------------------------------------------------------//