Square.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2016-2017 OpenFOAM Foundation
9 Copyright (C) 2016-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27\*---------------------------------------------------------------------------*/
28
29#include "Square.H"
30
31// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32
33template<class Type>
35(
36 const word& entryName,
37 const dictionary& dict,
38 const objectRegistry* obrPtr
39)
40:
41 Sine<Type>(entryName, dict, obrPtr),
42 mark_(dict.getOrDefaultCompat<scalar>("mark", {{"markSpace", 2006}}, 1)),
43 space_(dict.getOrDefault<scalar>("space", 1))
44{}
45
46
47template<class Type>
49:
50 Sine<Type>(rhs),
51 mark_(rhs.mark_),
52 space_(rhs.space_)
53{}
54
55
56// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
57
58template<class Type>
60{
61 os.writeEntryIfDifferent<scalar>("mark", 1, mark_);
62 os.writeEntryIfDifferent<scalar>("space", 1, space_);
64}
65
66
67template<class Type>
69{
71 os.endEntry();
72
73 os.beginBlock(word(this->name() + "Coeffs"));
74 writeEntries(os);
75 os.endBlock();
76}
77
78
79// ************************************************************************* //
A templated sine function, with support for offset etc.
Definition: Sine.H:208
virtual void writeEntries(Ostream &os) const
Write coefficient entries in dictionary format.
Definition: Sine.C:85
A templated square-wave function with support for offset, etc.
Definition: Square.H:228
virtual void writeEntries(Ostream &os) const
Write coefficient entries in dictionary format.
Definition: Square.C:59
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: Function1.H:96
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Registry of regIOobjects.
A class for handling words, derived from Foam::string.
Definition: word.H:68
OBJstream os(runTime.globalPath()/outputName)
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
dictionary dict