Index: dev_comm/excitation.txt =================================================================== --- dev_comm/excitation.txt (revision 23676) +++ dev_comm/excitation.txt (revision 23677) @@ -1,9 +1,28 @@ +** +Excitation type + +text describing things. For example every one of these includes the use of +DFDT which is a data structure used by openems and csxcad. Don't touch it +other than in the ways I describe. It's really something only thorsten +understands. + +User Inputs: + NameOfEntryBox +NameOfVar=___TypeOfVar___ Units (optional hover text or additional descrptive +info) + +% output format +code to be printfed always ending in an; + +** + Gaussian excitation It has 2 inputs we care about. They are frequencies the manual calls f0 and fc. +User Inputs: center frequency f0=____number___Hz @@ -10,12 +29,7 @@ 20db cutoff frequency fc=____number____Hz (bandwidth = 2*fc) - -technically there is another variable but lets assume we aren't trying to -support every mode of operation and just assume users who need it will have to -do some programming of their own. So just regurgitate the FDTD in the output - -format: +% output format: FDTD = SetGaussExcite(FDTD,f0,fc); ** @@ -22,9 +36,13 @@ Sinusoidal excitation +This is super self explanitory. + +User Inputs: sinewave frequency f0 = _number__Hz +% output format: FDTD = SetSinusExcite(FDTD,f0); ** @@ -31,8 +49,15 @@ Custom Excitation +I don't think it makes sense to have a text entry window large enough to +input. They could be entering a few term equation or a massive raw data file. +So I suggest we include a single line string entry that is copied into the +file ahead of the excitation line. +Doing that lets the user ether enter the string they want to use or the run +command with a file name which will run the file to load the data. +User Inputs: nyquest rate f0=__number__ Hz @@ -44,15 +69,7 @@ Function (or File name if the user checked the above box) FuncName(t) = ___string____ -I don't think it makes sense to have a text entry window large enough to -input. They could be entering a few term equation or a massive raw data file. -So I suggest we include a single line string entry that is copied into the -file ahead of the excitation line. - -Doing that lets the user ether enter the string they want to use or the run -command with a file name which will run the file to load the data. - - +% output format: % If they checked the box we do the following run filename; % If they didn't it's entering the line