ramped_electric_field

takes an electric field and modulates it with the time according to the selected profile. This field does not consider electrodynamics and just scales the underlying static field. It is only for sufficiently slowly varying fields. Don’t simulate an antenna with it!

For details please see the implementation of the different profiles in the code (the file is KRampedElectricField.cc).

XML element: <ramped_electric_field>
C++ type: KRampedElectricField
Also available as: ksfield_electric_ramped
Attributes

Attribute

Type

Description

name

string

the name of the electric field

num_cycles

int

how often the ramping up and down cycle is repeated

ramp_down_delay

double

delay before ramping down af

ramp_down_time

double

time the linear ramp down takes

ramp_up_delay

double

delay before ramping up

ramp_up_time

double

time the linear ramp up takes

ramping_type

string

linear, exponential and sinus are the options

Values: linear, exponential, sinus.

root_field

string

the name of the electric field that is to be varied with time

Refers to the name of one of: <constant_electric_field>, <electric_potentialmap>, <electric_quadrupole_field>, <electrostatic_field>, <induced_azimuthal_electric_field>, <linear_electric_field>, <ramped_electric_field>, <ramped_transitional_electric_field>.

time_constant

double

time constant for exponential ramping, otherwise unused value

time_scaling

double

scale all times by a factor for quick frequency change

Example:

<ramped_electric_field
    name="ramped_electric_field"
    root_field="electric_quadrupole"
    ramping_type="linear"
    num_cycles="10"
    ramp_up_delay="-0.1"
    ramp_down_delay="0.1"
    ramp_up_time="0.2"
    ramp_down_time="0.2"
    time_constant="2.0"
    time_scaling="1.0"

/>

Used as:

  • <ksfield_electric_ramped> (deprecated: define fields in the <kemfield> section instead (legacy alias)) in <kassiopeia>

  • <ramped_electric_field> in <kemfield>

Can be referenced by:

More information

Used in example configurations: