Derived type stimulation.
More...
Public Member Functions | |
| procedure | i_app => stim |
| type(stimulation) function | stimulation_create (f, L, t0, Rt, Rx, x0) |
| Constructor for the type stimulation More... | |
Public Attributes | |
| procedure(rtor), pointer, nopass | f => F_C3 |
| base function of the stimulation More... | |
| real(rp), dimension(3) | x0 = 0._RP |
| stimulation location More... | |
| real(rp) | t0 = 3._RP |
| stimulation time More... | |
| real(rp) | rt = 1._RP |
| radius in time of the stimulation ( = mid duration) More... | |
| real(rp) | rx = 0.15_RP |
| radius in space of the stimulation area More... | |
| real(rp) | l = 1.0_RP |
| amplitude More... | |
Detailed Description
Derived type stimulation.
WIth a vraiable
you can access the real function
defined as: \(\qquad\) s%I_app(x,t) = s%L * g1(x) * g2(t)
- \( x \in \R^3 \), \( t \in \R \)
- s%L = scalar amplitude
- g1(x) = s%f( | x - s%x0 | / s%Rx )
- g2(t) = s%f( | t - s%t0 | / s%Rt )
- s%L = stimulation amplitude
- s%x0 = stimulation center in space
- s%Rx = stimulation radius in space
- s%t0 = stimulation center in time (mid-time)
- s%Rt = stimulation radius in time (mid-duration)
- s%f = real valued finction,
(that can be set to a predefined function F_ck).
See stimulation_create.
Definition at line 69 of file stimulation_mod.f90.
Member Function/Subroutine Documentation
◆ i_app()
| procedure stimulation_mod::stimulation::i_app | ( | ) |
◆ stimulation_create()
| type(stimulation) function stimulation_mod::stimulation::stimulation_create | ( | procedure(rtor) | f, |
| real(rp), intent(in) | L, | ||
| real(rp), intent(in) | t0, | ||
| real(rp), intent(in) | Rt, | ||
| real(rp), intent(in) | Rx, | ||
| real(rp), dimension(3), intent(in), optional | x0 | ||
| ) |
Constructor for the type stimulation
- OUTPUT:
- s = stimulation
- INPUT:
- f = real valued function
- L = stimulation amplitude
- Rx = stimulation radius in space
- t0 = stimulation center in time (mid-time)
- Rt = stimulation radius in time (mid-duration)
- x0 = stimulation center in space, optional, default is 0
Definition at line 124 of file stimulation_mod.f90.
Member Data Documentation
◆ f
| procedure(rtor), pointer, nopass stimulation_mod::stimulation::f => F_C3 |
base function of the stimulation
Definition at line 72 of file stimulation_mod.f90.
◆ l
| real(rp) stimulation_mod::stimulation::l = 1.0_RP |
amplitude
Definition at line 87 of file stimulation_mod.f90.
◆ rt
| real(rp) stimulation_mod::stimulation::rt = 1._RP |
radius in time of the stimulation ( = mid duration)
Definition at line 81 of file stimulation_mod.f90.
◆ rx
| real(rp) stimulation_mod::stimulation::rx = 0.15_RP |
radius in space of the stimulation area
Definition at line 84 of file stimulation_mod.f90.
◆ t0
| real(rp) stimulation_mod::stimulation::t0 = 3._RP |
stimulation time
Definition at line 78 of file stimulation_mod.f90.
◆ x0
| real(rp), dimension(3) stimulation_mod::stimulation::x0 = 0._RP |
stimulation location
Definition at line 75 of file stimulation_mod.f90.
The documentation for this interface was generated from the following file:
- /home/cpierre1/choral/SRC/stimulation_mod.f90
