Skip to content

Conversation

@GardevoirX
Copy link
Contributor

Closes #104

This is still in a very early stage and subjected to change.

TODO:

  • Interface for getting the heat flux from the model
  • Checks for the applicability of unfolding the system
  • Tests
  • Documentations

Contributor (creator of pull-request) checklist

  • Tests updated (for new features and bugfixes)?
  • Documentation updated (for new features)?
  • Issue referenced (for PRs that solve an issue)?

Reviewer checklist

  • CHANGELOG updated with public API or any other important changes?

super().__init__()

self._model = model
# TODO: throw error if the simulation cell is smaller than double the interaction range
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keep in mind that long-range models will have an infinite interaction range

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure I will put it in the documentation that this method only supports local/semi-local models

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement a wrapper for heat flux calculation

2 participants