DataTransferKit - Multiphysics Solution Transfer Services  2.0
DTK_ClientManager.hpp
1 //---------------------------------------------------------------------------//
2 /*
3  Copyright (c) 2012, Stuart R. Slattery
4  All rights reserved.
5 
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are
8  met:
9 
10  *: Redistributions of source code must retain the above copyright
11  notice, this list of conditions and the following disclaimer.
12 
13  *: Redistributions in binary form must reproduce the above copyright
14  notice, this list of conditions and the following disclaimer in the
15  documentation and/or other materials provided with the distribution.
16 
17  *: Neither the name of the University of Wisconsin - Madison nor the
18  names of its contributors may be used to endorse or promote products
19  derived from this software without specific prior written permission.
20 
21  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33 //---------------------------------------------------------------------------//
39 //---------------------------------------------------------------------------//
40 
41 #ifndef DTK_CLIENTMANAGER_HPP
42 #define DTK_CLIENTMANAGER_HPP
43 
44 #include "DTK_EntityIntegrationRule.hpp"
45 #include "DTK_EntityLocalMap.hpp"
46 #include "DTK_EntitySet.hpp"
47 #include "DTK_EntityShapeFunction.hpp"
48 #include "DTK_Field.hpp"
49 #include "DTK_Types.hpp"
50 
51 #include <string>
52 
53 namespace DataTransferKit
54 {
55 //---------------------------------------------------------------------------//
63 //---------------------------------------------------------------------------//
65 {
66  public:
70  ClientManager() { /* ... */}
71 
75  virtual ~ClientManager() { /* ... */}
76 
80  virtual Teuchos::RCP<EntitySet> entitySet() const = 0;
81 
85  virtual Teuchos::RCP<EntityLocalMap> localMap() const = 0;
86 
90  virtual Teuchos::RCP<EntityShapeFunction> shapeFunction() const = 0;
91 
95  virtual Teuchos::RCP<EntityIntegrationRule> integrationRule() const = 0;
96 
100  virtual PredicateFunction selectFunction() const = 0;
101 
105  virtual Teuchos::RCP<Field>
106  field( const std::string &field_name ) const = 0;
107 };
108 
109 //---------------------------------------------------------------------------//
110 
111 } // end namespace DataTransferKit
112 
113 //---------------------------------------------------------------------------//
114 
115 #endif // end DTK_CLIENTMANAGER_HPP
116 
117 //---------------------------------------------------------------------------//
118 // end DTK_ClientManager.hpp
119 //---------------------------------------------------------------------------//
virtual PredicateFunction selectFunction() const =0
Get the selector function.
virtual Teuchos::RCP< EntityIntegrationRule > integrationRule() const =0
Get the integration rule for entities supporting the function.
virtual Teuchos::RCP< EntityShapeFunction > shapeFunction() const =0
Get the shape function for entities supporting the function.
virtual Teuchos::RCP< EntityLocalMap > localMap() const =0
Get the local map for entities supporting the function.
virtual Teuchos::RCP< EntitySet > entitySet() const =0
Get the entity set over which the fields are defined.
virtual Teuchos::RCP< Field > field(const std::string &field_name) const =0
Get the field for the given string key.
std::function< bool(Entity)> PredicateFunction
Predicate function typedef.
Definition: DTK_Types.hpp:64
virtual ~ClientManager()
Destructor.
DTK_BasicEntitySet.cpp.
ClientManager interface.