viewer (in electrostatic_field)

the viewer opens a window and displays the geometry. It can also save the geometry as in the vtk XML format. If KEMField is compiled without VTK support, the viewer is simply ignored.

XML element: <viewer>
C++ type: KVTKViewerAsBoundaryFieldVisitor
Attributes

Attribute

Type

Description

file

string

specify the name and location of the image data file in .vti format

path

string

postprocessing

bool

boolean option to start the viewer after the field solver initialization. There is no difference in the display between this option and the preprocessing variant. If both these parameters are true, the display pops up twice or the file is saved two times. The second time overwriting the data from the first save operation. Defaults to false.

preprocessing

bool

boolean option to start the viewer before the charge density solver initialization. Defaults to false.

save

bool

boolean option to save the generated geometry as a .vti file. Specify the name with the file parameter. Defaults to false.

view

bool

boolean option if true the image will be displayed in the preprocessing or postprocessing step of the field computation. Defaults to true.

Example:

<viewer
    view="true"
    preprocessing="true"
    postprocessing="true"
    file="ElectricFieldComplete.vti"
    save="true"
/>

Used as:

More information

Appears in the documentation:

Used in example configurations: