Skip to content

Commit

Permalink
doc: Fix docstring of ThreePointSusceptibilityContainer::computeAll()
Browse files Browse the repository at this point in the history
  • Loading branch information
krivenko committed Jan 22, 2024
1 parent 1c8dd92 commit 2b1eeaf
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions include/pomerol/ThreePointSusceptibilityContainer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,10 @@ class ThreePointSusceptibilityContainer
/// An empty set results in creation of elements for all possible index combinations \f$(i,j,k,l)\f$.
void prepareAll(std::set<IndexCombination4> const& Indices = {});
/// Compute all prepared elements \f$\chi^{(3)}_{ijkl}\f$.
/// \param[in] clear If true, computed \ref ThreePointSusceptibilityPart's of all elements will be destroyed
/// immediately after filling the precomputed value cache.
/// \param[in] clearTerms If true, computed \ref ThreePointSusceptibilityPart's of all elements will be destroyed
/// immediately after filling the precomputed value cache.
/// \param[in] freqs List of frequency duplets \f$(\omega_{n_1},\omega_{n_2})\f$ for value pre-computation.
/// \param[in] comm MPI communicator used to parallelize the computation.
/// \pre \ref prepareAll() has been called.
std::map<IndexCombination4, std::vector<ComplexType>>
computeAll(bool clearTerms = false, FreqVec2 const& freqs = {}, MPI_Comm const& comm = MPI_COMM_WORLD);
Expand Down
4 changes: 2 additions & 2 deletions src/pomerol/ThreePointSusceptibilityContainer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ void ThreePointSusceptibilityContainer::prepareAll(std::set<IndexCombination4> c
}

std::map<IndexCombination4, std::vector<ComplexType>>
ThreePointSusceptibilityContainer::computeAll(bool clear, FreqVec2 const& freqs, MPI_Comm const& comm) {
ThreePointSusceptibilityContainer::computeAll(bool clearTerms, FreqVec2 const& freqs, MPI_Comm const& comm) {
std::map<IndexCombination4, std::vector<ComplexType>> out;
for(auto& el : ElementsMap) {
INFO("Computing 3PSusceptibility for " << el.first);
auto& chi3 = static_cast<ThreePointSusceptibility&>(el.second);
out.emplace(el.first, chi3.compute(clear, freqs, comm));
out.emplace(el.first, chi3.compute(clearTerms, freqs, comm));
}
return out;
}
Expand Down

0 comments on commit 2b1eeaf

Please sign in to comment.