Use this object to define a field source for the simulation.
Reset ()
Resets all internal settings to their default values.
Name ( string name )
Specifies the name for the current distribution.
FileName ( string name )
Specifies the name of the field source data file. Available for import are CST MICROWAVE STUDIO FSM files (*.fsm), CST MICROWAVE STUDIO hexanhedral field monitors (*.m3d), CST MPHYSICS STUDIO displacement files (*.fic), CST CABLE STUDIO / CST PCB STUDIO RSD files (*.rsd), or Sigrity® NFD files (*.nfd).
SetDownsampling ( string downsample_ratio, string sample_fmin, string sample_fmax )
Specifies the down sampling of imported frequency data points. The first parameter downsample_ratio corresponds to the down sampling step whereas sample_fmin and sample_fmax select a reduced frequency range.
downsample_ratio must be an integer number in the range [1, Nfreq] where Nfreq is the number of available imported frequencies and the value "1" corresponds to no down sampling.
sample_fmin and sample_fmax correspond to the sample position of the first and last desired frequency point of the imported data. They must be integer numbers in the range [0, Nfreq-1].
The down sampled sequence is always generated to fulfill the "equidistant" and "zero frequency base" properties which are required by the solver to perform the numerical simulation.
The term "equidistant" means that the frequency sampling should be equidistant.
The term "zero frequency base" means that the sequence of frequency points must exactly hit the zero frequency when extending equidistantly at the lower frequency end.
As an example, if the imported file contains the frequency samples
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
the frequency sequence obtained with Downsampling ratio=4
4, 8, 12
is an equidistant - zero frequency base sequence, whereas
3, 7, 11
is still equidistant but not any more zero frequency based (extrapolating the sequence using frequency step=4 does not hit the 0 frequency value).
Delete ( string name )
Deletes an existing field source, which is specified by the name.
DeleteAll
Delete all field sources.
Rename ( string oldname, string newname )
Renames an existing field source from oldname to newname.
UseRelativePath (bool flag)
Defines if the FileName is given with a relative or absolute path. This setting is available only for temperature- (*.m3d) or displacement-fields (*.fic).
UseCopyOnly (bool flag)
Defines if the internal copy of the field import should be used only. If this setting is activated, the field is not updated anymore, even if the source field has changed. This setting is available only for temperature- (*.m3d) or displacement-fields (*.fic).
Read
Activates the import, which has to be previously specified using the FileName method. This method is used for the following file types: *.rsd, *.fsm, and *.nfd.
CreateFieldImport
Creates a temperature- (*.m3d) or displacement- (*.fic) field import, which needs to be specified with the FileName method.
' Define a FieldSource
With FieldSource
.Reset
.Name ("CD1")
.Filename ("test.rsd")
.Read
End With
'Delete the FieldSource
FieldSource .Delete ("CD1")