Skip to content

Document multiple CEP stimuli #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ktbolt merged 1 commit into from
Jul 16, 2026
Merged

Document multiple CEP stimuli #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions documentation/multi_physics/solver-input-file/domain_parameters/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The <i>Domain Subsection</i> is organized as follows
<br>
&lt;<strong>Viscosity</strong>&gt;
<br><br>
&lt;<strong>Stimulus</strong> type=<i>stimulus_type</i>&gt;<br>
&lt;<strong>Stimulus</strong> type=<i>stimulus_type</i>&gt; <i>(repeatable)</i><br>
[<a href="#domain_Stimulus_subsection"> Stimulus Subsection </a> ]
<br>
&lt;<strong>Stimulus</strong>&gt;
Expand Down Expand Up @@ -419,17 +419,24 @@ The <strong>Stimulus</strong> keyword adds stimulus settings to the enclosing do
<li> "Istim" - the applied stimulus is a source current and not a voltage source </li>
</ul>

Multiple <strong>&lt;Stimulus&gt;</strong> elements may be placed within the same explicit
<strong>&lt;Domain&gt;</strong> subsection, or under the equation-level default domain when no
explicit domain subsection is used. Each stimulus is evaluated independently using its own
amplitude, timing parameters, and optional spatial bounds. When multiple stimuli are active at
the same node and time, their amplitudes are summed. Defining no <strong>&lt;Stimulus&gt;</strong>
elements produces no applied stimulus; defining one applies only that stimulus.

<h5 id="stimulus_parameters"> Parameters </h5>
<div class="bc_param_div">
<strong>&lt;Amplitude&gt;</strong> <i>real</i> [0.0] <nobr>
<strong>&lt;/Amplitude&gt;</strong>
</nobr><br>
The stimulus amplitude.
The stimulus amplitude. An omitted or zero-valued amplitude contributes no stimulus.
<br>
<strong>&lt;Cycle_length&gt;</strong> <i>real</i> [0.0] <nobr>
<strong>&lt;Cycle_length&gt;</strong> <i>real</i> [total simulation duration] <nobr>
<strong>&lt;/Cycle_length&gt;</strong>
</nobr><br>
The stimulus cycle length.
The stimulus cycle length. When omitted, the total simulation duration is used. For a stimulus with a nonzero amplitude, the cycle length must be greater than zero.
<br>
<strong>&lt;Duration&gt;</strong> <i>real</i> [0.0] <nobr>
<strong>&lt;/Duration&gt;</strong>
Expand Down