Add warning to complex-field nonlinearities #2068
Merged
+31
−14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
momchil-flex
approved these changes
Nov 13, 2024
tidy3d/components/medium.py
Outdated
| log.warning( | ||
| "Found a medium with a 'TwoPhotonAbsorption' nonlinearity. " | ||
| "This uses a phenomenological model based on complex fields, " | ||
| "so care should be taken in interpreting the results." |
There was a problem hiding this comment.
Can we reference something for more information?
FilipeFcp
approved these changes
Nov 13, 2024
caseyflex
force-pushed
the
casey/warnnonlinear
branch
from
8a49bfc
to
ebcae20
Compare
caseyflex
force-pushed
the
casey/warnnonlinear
branch
from
ebcae20
to
91701d4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some of the nonlinearities use complex fields to realize certain effects, which may be a good model in certain circumstances but can deviate from the underlying physics. I added some warnings to make sure that the user knows what they are doing (and doesn't inadvertently use KerrNonlinearity when NonlinearSusceptibility is more appropriate, for example). These warnings will always show whenever complex-field nonlinearities are present.