 |
Holds the output of a celes_simulation. More...
Public Member Functions | |
| function get | totalField (in obj) |
| Get method for totalField. More... | |
Public Attributes | |
| Property | initialFieldPower |
| power flux of the initial field More... | |
| Property | scatteredFieldPlaneWavePattern |
| celes_planeWavePattern object for the scattered field More... | |
| Property | totalFieldPlaneWavePattern |
| celes_planeWavePattern object for the total field More... | |
| Property | totalFieldForwardPower |
| power flux of the toal field in +z direction More... | |
| Property | totalFieldBackwardPower |
| power flux of the toal field in -z direction More... | |
| Property | initialField |
| electric (near) field values of the initial field at the points specified in fieldPoints More... | |
| Property | initialFieldUseParaxialApproximation |
| if true, the paraxial approximation is used for the electric field evaluation of the initial field, otherwise compute initial field from angular spectrum representation More... | |
| Property | scatteredField |
| electric (near) field values of the scattered field at the points specified in fieldPoints More... | |
| Property | internalField |
| electric (near) field values of the internal field at the points specified in fieldPoints More... | |
| Property | internalIndices |
| indices that correspond to field points that are inside some sphere More... | |
| Property | fieldPoints |
| points at which the electric field is to be evaluated, in the format [x(:),y(:),z(:)] More... | |
| Property | fieldPointsArrayDims |
| if the field points lie on a plane (in order to display the field as an image), fieldPointsArrayDims stores the size of the image - which can be recustructed by using reshape(...,fieldPointsArrayDims) More... | |
| Property | convergenceHistory |
| array of the relative error of the solution as a function of iteration step number. More... | |
| Property | totalTime |
| time used for the simulation More... | |
| Property | solverTime |
| time used by the solver of the linear system More... | |
| Property | preconiditionerPreparationTime |
| time used for the preparation of the preconditioner More... | |
| Property | runningTime |
| time used for the simulation.run command More... | |
| Property | powerEvaluationTime |
| time used for the power evaluation More... | |
| Property | fieldEvaluationTime |
| time used for the field evaluation More... | |
| Property | totalField |
| electric (near) field values of the total field at the points specified in fieldPoints More... | |
Detailed Description
Holds the output of a celes_simulation.
Member Function Documentation
◆ totalField()
| function get totalField | ( | in | obj | ) |
Get method for totalField.
Member Data Documentation
◆ convergenceHistory
| Property convergenceHistory |
array of the relative error of the solution as a function of iteration step number.
for bicgstab algorithm, the half-steps are counted
◆ fieldEvaluationTime
| Property fieldEvaluationTime |
time used for the field evaluation
◆ fieldPoints
| Property fieldPoints |
points at which the electric field is to be evaluated, in the format [x(:),y(:),z(:)]
◆ fieldPointsArrayDims
| Property fieldPointsArrayDims |
if the field points lie on a plane (in order to display the field as an image), fieldPointsArrayDims stores the size of the image - which can be recustructed by using reshape(...,fieldPointsArrayDims)
◆ initialField
| Property initialField |
electric (near) field values of the initial field at the points specified in fieldPoints
◆ initialFieldPower
| Property initialFieldPower |
power flux of the initial field
◆ initialFieldUseParaxialApproximation
| Property initialFieldUseParaxialApproximation |
if true, the paraxial approximation is used for the electric field evaluation of the initial field, otherwise compute initial field from angular spectrum representation
◆ internalField
| Property internalField |
electric (near) field values of the internal field at the points specified in fieldPoints
◆ internalIndices
| Property internalIndices |
indices that correspond to field points that are inside some sphere
◆ powerEvaluationTime
| Property powerEvaluationTime |
time used for the power evaluation
◆ preconiditionerPreparationTime
| Property preconiditionerPreparationTime |
time used for the preparation of the preconditioner
◆ runningTime
| Property runningTime |
time used for the simulation.run command
◆ scatteredField
| Property scatteredField |
electric (near) field values of the scattered field at the points specified in fieldPoints
◆ scatteredFieldPlaneWavePattern
| Property scatteredFieldPlaneWavePattern |
celes_planeWavePattern object for the scattered field
◆ solverTime
| Property solverTime |
time used by the solver of the linear system
◆ totalField
| Property totalField |
electric (near) field values of the total field at the points specified in fieldPoints
◆ totalFieldBackwardPower
| Property totalFieldBackwardPower |
power flux of the toal field in -z direction
◆ totalFieldForwardPower
| Property totalFieldForwardPower |
power flux of the toal field in +z direction
◆ totalFieldPlaneWavePattern
| Property totalFieldPlaneWavePattern |
celes_planeWavePattern object for the total field
◆ totalTime
| Property totalTime |
time used for the simulation
The documentation for this class was generated from the following file:
- src/classes/celes_output.m
Generated by
1.8.13