BCInterfaceData0D.hpp 4.37 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
//@HEADER
/*
*******************************************************************************

    Copyright (C) 2004, 2005, 2007 EPFL, Politecnico di Milano, INRIA
    Copyright (C) 2010 EPFL, Politecnico di Milano, Emory University

    This file is part of LifeV.

    LifeV is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    LifeV is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with LifeV.  If not, see <http://www.gnu.org/licenses/>.

*******************************************************************************
*/
//@HEADER

/*!
 *  @file
 *  @brief File containing the BCInterfaceData0D class
 *
 *  @date 17-07-2009
 *  @author Cristiano Malossi <cristiano.malossi@epfl.ch>
 *
 *  @maintainer Cristiano Malossi <cristiano.malossi@epfl.ch>
 */

#ifndef BCInterfaceData0D_H
#define BCInterfaceData0D_H 1

// 1D BCHandler include
41
#include <lifev/zero_dimensional/fem/ZeroDimensionalBCHandler.hpp>
42
43

// BCInterface includes
44
#include <lifev/core/fem/BCInterfaceData.hpp>
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

namespace LifeV
{

//! BCInterfaceData0D - The BCInterface1D data container
/*!
 *  @author Cristiano Malossi
 *
 *  The BCInterfaceData0D class provides a general container for all the data
 *  required by the 0D boundary conditions.
 */
class BCInterfaceData0D: public virtual BCInterfaceData
{
public:

    //! @name Type definitions
    //@{

    typedef BCInterfaceData                                                     dataContainer_Type;
    typedef ZeroDimensionalBCHandler::bcType_Type                               bcType_Type;

    //@}


    //! @name Constructors & Destructor
    //@{

    //! Constructor
    explicit BCInterfaceData0D();

    //! Copy constructor
    /*!
     * @param data BCInterfaceData0D
     */
    BCInterfaceData0D( const BCInterfaceData0D& data );

    //! Destructor
    virtual ~BCInterfaceData0D() {}

    //@}


    //! @name Operators
    //@{

    //! Operator =
    /*!
     * @param data BCInterfaceData0D
     * @return reference to a copy of the class
     */
    BCInterfaceData0D& operator=( const BCInterfaceData0D& data );

    //@}


    //! @name Methods
    //@{

    //! Read parameters for all kind of BC
    /*!
     * @param fileName Name of the data file.
     * @param dataSection BC section
     * @param name name of the boundary condition
     */
    void readBC( const std::string& fileName, const std::string& dataSection, const std::string& name );

    //! Display general information about the content of the class
    /*!
     * @param output specify the output format (std::cout by default)
     */
    void showMe( std::ostream& output = std::cout ) const;

    //@}


    //! @name Set Methods
    //@{

    //! Set the flag of the boundary condition
    /*!
     * @param flag Boundary condition flag
     */
    void setFlag( const bcFlag_Type& flag ) { M_flag = flag; }

    //! Set the type of the boundary condition
    /*!
     * @param type Boundary condition type
     */
    void setType( const bcType_Type& type ) { M_type = type; }

    //@}


    //! @name Get Methods
    //@{

    //! Get the flag of the boundary condition
    /*!
     * @return Boundary condition flag
     */
    const bcFlag_Type& flag() const { return M_flag; }

    //! Get the type of the boundary condition
    /*!
     * @return Boundary condition type
     */
    const bcType_Type& type() const { return M_type; }

    //@}

private:

    //! @name Private Methods
    //@{

    void readFlag( const GetPot& dataFile, const char* flag ) { M_flag = dataFile( flag, 0 ); }

    void readType( const GetPot& dataFile, const char* type ) { M_type = M_mapType[dataFile( type, "Current" )]; }

    //@}


    //! @name Private Members
    //@{


    bcFlag_Type                                                    M_flag;
    bcType_Type                                                    M_type;


    // Maps
    std::map< std::string, bcType_Type >                           M_mapType;

    //@}
};

} // Namespace LifeV

#endif /* BCInterfaceData0D_H */