MCPcopy Create free account
hub / github.com/NanoComp/meep / ForceRegion

Class ForceRegion

python/simulation.py:571–595  ·  view source on GitHub ↗

A region (volume, plane, line, or point) in which to compute the integral of the stress tensor of the Fourier-transformed fields. Its properties are: + **`center` [ `Vector3` ]** — The center of the force region (no default). + **`size` [ `Vector3` ]** — The size of the force regi

Source from the content-addressed store, hash-verified

569
570
571class ForceRegion(FluxRegion):
572 """
573 A region (volume, plane, line, or point) in which to compute the integral of the
574 stress tensor of the Fourier-transformed fields. Its properties are:
575
576 + **`center` [ `Vector3` ]** — The center of the force region (no default).
577
578 + **`size` [ `Vector3` ]** — The size of the force region along each of the coordinate
579 axes. Default is `(0,0,0)` (a single point).
580
581 + **`direction` [ `direction constant` ]** — The direction of the force that you wish
582 to compute (e.g. `X`, `Y`, etcetera). Unlike `FluxRegion`, you must specify this
583 explicitly, because there is not generally any relationship between the direction of
584 the force and the orientation of the force region.
585
586 + **`weight` [ `complex` ]** — A weight factor to multiply the force by when it is
587 computed. Default is 1.0.
588
589 + **`volume` [ `Volume` ]** — A `meep.Volume` can be used to specify the force region
590 instead of a `center` and a `size`.
591
592 In most circumstances, you should define a set of `ForceRegion`s whose union is a
593 closed surface lying in vacuum and enclosing the object that is experiencing the
594 force.
595 """
596
597
598class EnergyRegion(FluxRegion):

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected