Просмотр исходного текста страницы Input and Output operations using dictionaries and the IOobject class

<categorytree mode=pages style="float:right; clear:right; margin-left:1ex; border:1px solid gray; padding:0.7ex; background-color:white;">OpenFOAM руководство кодера</categorytree>

Многие операции ввода-вывода выполняются в OpenFOAM с помощью класса IOobject, который описывается в его заголовочном файле следующим образом:

''IOobject определяет атрибуты объекта, для которого поддерживается неявное управление  [[snip_objectRegistry|objectRegistry]], и предоставляет инфраструктуру для работы потока ввода-вывода (I/O). IOobject содержит имя объекта, имя класса, путь к сущности (instance), ссылку на  objectRegistry, и параметры, определяющие параметры его хранения.''

== <code>IOobject</code> конструкторы ==

Конструктор <code>IOobject</code> может иметь 2 формы:

1. Построение из имени (name), сущности (instance), реестра и IO-опций:


 IOobject  	
 (  
     const word &   	 	 name,
     const word &  		 instance,
     const objectRegistry &   	 registry,
     readOption  		 r = NO_READ,
     writeOption  		 w = NO_WRITE,
     bool  			 registerObject = true
 )


2. Построение из имени, сущности (instance), расположения (local), реестра и IO-опций:


 IOobject  	
 (
     const word &   	 	 name,
     const word &  		 instance,
     const fileName &  		 local,
     const objectRegistry &  	 registry,
     readOption  		 r = NO_READ,
     writeOption  		 w = NO_WRITE,
     bool  			 registerObject = true
 )


В двух предыдущих фрагментах кода, помните, что  <code>word</code> наследует <code>string</code>, из которой также происходит <code>fileName</code>. Более того, <code>Time</code> и <code>polyMesh</code> наследуют <code>objectRegistry</code>. Как следствие <code>fvMesh</code>, наследуя <code>polyMesh</code>, косвенно наследует и <code>objectRegistry</code>. Дополнительные сведения смотрите в справочнике [http://foam.sourceforge.net/docs/cpp/a00926.html IOobject class reference].

== Параметры чтения ==
Параметры чтения, определяющие, что делается при создании объекта и явном чтении:

* <code>MUST_READ</code> – объект должен быть считан из <code>Istream</code> при создании. Если <code>Istream</code> не существует или не может быть прочитан, выдаётся сообщение об ошибке.
* <code>READ_IF_PRESENT</code> – считывает объект из <code>Istream</code> если <code>Istream</code> существует, в противном случае, нет. Сообщение об ошибке выдаётся только в том случае, если <code>Istream</code> существует, но не может быть прочитан.
* <code>NO_READ</code> – не читать объект.

== Параметры записи ==
Параметрами записи, определяющие, что делается при уничтожении объекта и записи в явном виде:

* <code>AUTO_WRITE</code> – объект записывается автоматически по запросу <code>objectRegistry</code>.
* <code>NO_WRITE</code> – объект не записывается автоматически при уничтожении, но может быть записан явно.

== <code>IOobject</code> и словари ==
Словари могут быть прочитаны с помощью класса <code>IOobject</code>, когда они объявлены. Обычно <code>readOption</code> для словаря - это <code>MUST_READ</code>, а <code>writeOption</code> это <code>NO_WRITE</code>, чтобы не перезаписывать настройки, содержащиеся в словаре .
Например, код, необходимый для чтения словаря <code>transportProperties</code> это:


 IOdictionary transportProperties
 (
      IOobject
      (
           "transportProperties",
           runTime.constant(),
           mesh,
           IOobject::MUST_READ,
           IOobject::NO_WRITE
      )
 );

В этом случае принимается первая форма конструктора, где:

* <code>transportProperties</code> это имя файла, содержащего словарь.
* <code>runTime.constant()</code>, инстанс, задающий расположение словаря, который в данном случае содержится директории <code>constant</code>.
* <code>objectRegistry</code> представлен сеткой (mesh).

== <code>IOobject</code> и поля ==
Аналогично словарям, параметры чтения и записи для поля можно задать с помощью класса <code>IOobject</code>. Синтаксис почти одинаков для всех типов полей, и показан на следующем примере.
Если мы хотим определить <code>volScalarField</code> с именем <code>T</code>, сохраняя его в определённые пользователем интервалы времени в файле с именем <code>T</code>:


 volScalarField T
 (
     IOobject
     (
         "T",
         runTime.timeName(),
         mesh,
         IOobject::MUST_READ,
         IOobject::AUTO_WRITE
     ),
     mesh
 );


Где:
* <code>T</code> это имя файла.
* <code>runTime.timeName()</code> - говорит OpenFOAM, чтобы сохранить файл в каталог названный значением текущего времени.
* <code>mesh</code> это <code>objectRegistry</code>.
* Опции чтения и написания устанавлены в <code>MUST_READ</code> и <code>AUTO_WRITE</code> соответственно, чтобы OpenFOAM записал поле и автоматически сохранил его. Если чтение поля не требуется, параметр <code>MUST_READ</code> должен быть заменён на <code>NO_READ</code>.

Ссылка на оригинал - http://openfoamwiki.net/index.php/OpenFOAM_guide/Input_and_Output_operations_using_dictionaries_and_the_IOobject_class

[[Категория:OpenFOAM]]
[[Категория:OpenFOAM руководство кодера]]