Skip to content

Commit dbf70cf

Browse files
committed
injector_boundary_inflow: add comment
1 parent 1328bdb commit dbf70cf

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

src/include/injector_boundary_inflow.hxx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,12 @@ public:
7373
prts_per_unit_density{grid.norm.prts_per_unit_density}
7474
{}
7575

76+
/// Injects particles at the lower y-bound as if there were a population of
77+
/// particles just beyond the edge. The imaginary particle population has unit
78+
/// density, and individual particles from that population are sampled using
79+
/// the given ParticleGenerator.
80+
///
81+
/// Some of these limitations may be removed in the future.
7682
void operator()(Mparticles& mprts, MfieldsState& mflds)
7783
{
7884
static_assert(INJECT_DIM_IDX_ == 1,

0 commit comments

Comments
 (0)