midrexFOAM/solidComponent.H at master · souravpd/midrexFOAM · GitHub

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
41
42
43
44
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
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

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

    OpenFOAM 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 General Public License
    for more details.

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

Class
    Foam::solidComponent

Description
    Single incompressible solution solidComponent.
    Used as part of the multiComponentSolution to store solidComponent data.

SourceFiles
    solidComponent.C

Author
    Rudolf Hellmuth (rudolf.hellmuth@gmail.com)

\*---------------------------------------------------------------------------*/

#include "volFields.H"
#include "dictionaryEntry.H"

#ifndef solidComponent_H
#define solidComponent_H

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
                           Class solidComponent Declaration
\*---------------------------------------------------------------------------*/

class solidComponent
:
    public volScalarField
{
    // Private data

        word name_;
        dictionary solidComponentDict_;

        dimensionedScalar D_;
        word diffusionModel_;

public:

    // Constructors

        //- Construct from components
        solidComponent
        (
            const dictionary& solidComponentDict,
            const fvMesh& mesh
        );

        //- Return clone
        autoPtr<solidComponent> clone() const;

        //- Return a pointer to a new solidComponent created on freestore
        //  from Istream
        class iNew
        {
            const fvMesh& mesh_;

        public:

            iNew
            (
                const fvMesh& mesh
            )
            :
                mesh_(mesh)
            {}
            autoPtr<solidComponent> operator()(Istream& is) const
            {
                dictionaryEntry ent(dictionary::null, is);
                return autoPtr<solidComponent>(new solidComponent(ent, mesh_));
            }
        };

    // Destructor


    // Member Functions

        const word& name() const
        {
            return name_;
        }

        const word& keyword() const
        {
            return name();
        }

        //- Return const-access to solidComponent diffusion coefficient
        const dimensionedScalar& D() const
        {
            return D_;
        }

        //- Return const-access to solidComponent diffusion model
        const word& diffusionModel() const
        {
            return diffusionModel_;
        }

        //- Return const-access to solidComponent molar mass
//        const dimensionedScalar& molarMass() const
//        {
//            return molarMass_;
//        }

        //- Read base transportProperties dictionary
        bool read(const dictionary& solidComponentDict);
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //