1 // Copyright (C) 2007-2021 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 // WARNING: this file is part of the official ICoCo API and should not be modified.
21 // The official version can be found at the following URL:
23 // https://github.com/cea-trust-platform/icoco-coupling
25 #ifndef ICoCoMEDDoubleField_included
26 #define ICoCoMEDDoubleField_included
28 #include "ICoCoField.hxx"
33 class MEDCouplingFieldDouble;
38 /*! @brief Field data stored internally as a MEDCoupling object.
40 * This class is a wrapper around a MEDCoupling::MEDCouplingFieldDouble object, which holds the field data.
41 * In version 2 of ICoCo, MEDCoupling::MEDCouplingFieldDouble objects are not anymore exposed directly into the API
42 * of ICoCo::Problem. The rationale is to make the interface ICoCo::Problem free of external dependencies
43 * (MEDCoupling particularly).
45 * @sa the MEDCoupling documentation, notably the reference counter mechanism used to manage the lifecycle of
46 * MEDCoupling objects.
48 class MEDCOUPLINGICOCO_EXPORT MEDDoubleField : public ICoCo::Field
51 /*! Builds an empty field (internal MEDCoupling object not set).
55 /*! @brief Builds a field and assign its internal MEDCouplingField object.
57 * The name of 'this' is also automatically set the name of the MEDCouplingField object. If 'field' is null
58 * the name is set to the empty string.
60 * @param field MEDCoupling field instance to use for field data. The field reference counter is incremented.
62 MEDDoubleField(MEDCoupling::MEDCouplingFieldDouble* field);
64 /*! @brief Copy construcotr.
66 MEDDoubleField(const MEDDoubleField& field);
68 /*! @brief Assignement operator.
69 * @param field another MEDDoubleField instance. The previous internal MEDCoupling field reference (if any) has
70 * its counter decremented.
72 MEDDoubleField& operator=(const MEDDoubleField& field);
74 /*! @brief Destructor.
76 virtual ~MEDDoubleField();
78 /*! @brief Get the internal MEDCoupling field object.
79 * @return a pointer to the MEDCouplingField object detained by this instance. Note that the corresponding
80 * object should not be deleted, or its reference counter should not be decreased! Doing so will result in an
81 * invalid instance of the current MEDField.
83 MEDCoupling::MEDCouplingFieldDouble *getMCField() const;
85 /*! @brief Set the internal MEDCoupling field object.
87 * Any previously set field is discarded (its reference counter is decreased) and the reference counter of the
88 * field being set is increased.
90 * The name of 'this' is also automatically set the name of the MEDCouplingField object. If 'field' is nullptr
91 * the name is reset to the empty string.
93 * @param field MEDCouplingFieldDouble object to be used.
95 void setMCField(MEDCoupling::MEDCouplingFieldDouble * field);
98 MEDCoupling::MEDCouplingFieldDouble *_field;