ZeroDimensionalBC.hpp 3.41 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
//@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 zero dimensional BCHandler
 *
 *  @date 30-03-2011
 *  @author Cristiano Malossi <cristiano.malossi@epfl.ch>
 *
 *  @maintainer Cristiano Malossi <cristiano.malossi@epfl.ch>
 */

#ifndef ZeroDimensionalBC_H
#define ZeroDimensionalBC_H 1

40
#include <lifev/zero_dimensional/solver/ZeroDimensionalDefinitions.hpp>
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

namespace LifeV
{

//! ZeroDimensionalBC - A boundary condition for zero-dimensional models
/*!
 *  @author Cristiano Malossi
 *
 *  This simple class is a boundary condition for simple zero-dimensional models.
 */
class ZeroDimensionalBC
{
public:

    //! @name Type definitions
    //@{

    typedef boost::function<Real ( const Real&  )>                        function_Type;
59
    typedef ZeroDimensionalBCType                                         bcType_Type;
60
61
62
63
64
65
66
67
68
69

    //@}


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

    //! Constructor
    explicit ZeroDimensionalBC() : M_function(), M_bcType() {}

70
    ZeroDimensionalBC( const ZeroDimensionalBC& bc ) :
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
                    M_function( bc.M_function ),
                    M_bcType  ( bc.M_bcType ) {}

    //! Destructor
    virtual ~ZeroDimensionalBC() {}

    //@}


    //! @name Methods
    //@{

    //! Evaluate the bc
    /*!
     * @param time the current time of the simulation
     * @return the bc value
    */
    Real evaluate( const Real& time ) const { return M_function( time ); }

    //@}


    //! @name Set Methods
    //@{

    //! Set the function
    /*!
      @param function the user defined function
    */
    void setBC( const bcType_Type& bcType, const function_Type& function ) { M_bcType = bcType; M_function = function; }

    //! Set the function
    /*!
      @param function the user defined function
    */
    void setFunction( const function_Type& function ) { M_function = function; }

    //! Set the type
    /*!
      @param bcType the bc type
    */
    void setBcType( const bcType_Type& bcType ) { M_bcType = bcType; }

    //@}


    //! @name Get Methods
    //@{

    //! Get the function
    /*!
      @return the user defined function
    */
    const function_Type& function() const { return M_function; }

    //! Get the type
    /*!
      @return the bc type
    */
    const bcType_Type& bcType() const { return M_bcType; }

    //@}

private:

    function_Type               M_function;
    bcType_Type                 M_bcType;
};

} // Namespace LifeV

#endif /* ZeroDimensionalBCHandler_H */