diff --git a/amrex/docs_html/_downloads/008eb6dbfab802633dff40122ece848c/amrex.pdf b/amrex/docs_html/_downloads/008eb6dbfab802633dff40122ece848c/amrex.pdf index 1257ea2740..1813aaa59c 100644 Binary files a/amrex/docs_html/_downloads/008eb6dbfab802633dff40122ece848c/amrex.pdf and b/amrex/docs_html/_downloads/008eb6dbfab802633dff40122ece848c/amrex.pdf differ diff --git a/amrex/docs_html/doxygen/AMReX__MultiFab_8H_source.html b/amrex/docs_html/doxygen/AMReX__MultiFab_8H_source.html index 464580c0ac..153f1ec691 100644 --- a/amrex/docs_html/doxygen/AMReX__MultiFab_8H_source.html +++ b/amrex/docs_html/doxygen/AMReX__MultiFab_8H_source.html @@ -232,272 +232,274 @@
231  [[nodiscard]] Real norm2 (int comp, const Periodicity& period) const;
236  [[nodiscard]] Vector<Real> norm2 (const Vector<int>& comps) const;
240  [[nodiscard]] Real sum (int comp = 0, bool local = false) const;
-
241 
-
242  using FabArray<FArrayBox>::sum;
-
243 
-
248  [[nodiscard]] Real sum_unique (int comp = 0,
-
249  bool local = false,
-
250  const Periodicity& period = Periodicity::NonPeriodic()) const;
-
260  void plus (Real val,
-
261  int comp,
-
262  int num_comp,
-
263  int nghost = 0);
-
269  void plus (Real val,
-
270  const Box& region,
-
271  int comp,
-
272  int num_comp,
-
273  int nghost = 0);
-
280  void plus (Real val,
-
281  int nghost);
-
289  void plus (Real val,
-
290  const Box& region,
-
291  int nghost);
-
300  void mult (Real val,
-
301  int comp,
-
302  int num_comp,
-
303  int nghost = 0);
-
311  void mult (Real val,
-
312  const Box& region,
-
313  int comp,
-
314  int num_comp,
-
315  int nghost = 0);
-
322  void mult (Real val,
-
323  int nghost = 0);
-
331  void mult (Real val,
-
332  const Box& region,
-
333  int nghost = 0);
-
342  void invert (Real numerator,
-
343  int comp,
-
344  int num_comp,
-
345  int nghost = 0);
-
353  void invert (Real numerator,
-
354  const Box& region,
-
355  int comp,
-
356  int num_comp,
-
357  int nghost = 0);
-
364  void invert (Real numerator,
-
365  int nghost);
-
373  void invert (Real numerator,
-
374  const Box& region,
-
375  int nghost);
-
383  void negate (int comp,
-
384  int num_comp,
-
385  int nghost = 0);
-
391  void negate (const Box& region,
-
392  int comp,
-
393  int num_comp,
-
394  int nghost = 0);
-
400  void negate (int nghost = 0);
-
407  void negate (const Box& region,
-
408  int nghost = 0);
-
409 
-
410  [[nodiscard]] IntVect minIndex (int comp,
-
411  int nghost = 0) const;
-
412 
-
413  [[nodiscard]] IntVect maxIndex (int comp,
-
414  int nghost = 0) const;
-
424  void plus (const MultiFab& mf,
-
425  int strt_comp,
-
426  int num_comp,
-
427  int nghost);
-
437  void minus (const MultiFab& mf,
-
438  int strt_comp,
-
439  int num_comp,
-
440  int nghost);
-
451  void divide (const MultiFab& mf,
-
452  int strt_comp,
-
453  int num_comp,
-
454  int nghost);
-
458  static Real Dot (const MultiFab& x, int xcomp,
-
459  const MultiFab& y, int ycomp,
-
460  int numcomp, int nghost, bool local = false);
-
461 
-
465  static Real Dot (const MultiFab& x, int xcomp,
-
466  int numcomp, int nghost, bool local = false);
-
467 
-
468  static Real Dot (const iMultiFab& mask,
-
469  const MultiFab& x, int xcomp,
+
244  [[nodiscard]] Real sum (Box const& region, int comp = 0, bool local = false) const;
+
245 
+
246  using FabArray<FArrayBox>::sum;
+
247 
+
252  [[nodiscard]] Real sum_unique (int comp = 0,
+
253  bool local = false,
+
254  const Periodicity& period = Periodicity::NonPeriodic()) const;
+
261  [[nodiscard]] Real sum_unique (Box const& region, int comp = 0, bool local = false) const;
+
271  void plus (Real val,
+
272  int comp,
+
273  int num_comp,
+
274  int nghost = 0);
+
280  void plus (Real val,
+
281  const Box& region,
+
282  int comp,
+
283  int num_comp,
+
284  int nghost = 0);
+
291  void plus (Real val,
+
292  int nghost);
+
300  void plus (Real val,
+
301  const Box& region,
+
302  int nghost);
+
311  void mult (Real val,
+
312  int comp,
+
313  int num_comp,
+
314  int nghost = 0);
+
322  void mult (Real val,
+
323  const Box& region,
+
324  int comp,
+
325  int num_comp,
+
326  int nghost = 0);
+
333  void mult (Real val,
+
334  int nghost = 0);
+
342  void mult (Real val,
+
343  const Box& region,
+
344  int nghost = 0);
+
353  void invert (Real numerator,
+
354  int comp,
+
355  int num_comp,
+
356  int nghost = 0);
+
364  void invert (Real numerator,
+
365  const Box& region,
+
366  int comp,
+
367  int num_comp,
+
368  int nghost = 0);
+
375  void invert (Real numerator,
+
376  int nghost);
+
384  void invert (Real numerator,
+
385  const Box& region,
+
386  int nghost);
+
394  void negate (int comp,
+
395  int num_comp,
+
396  int nghost = 0);
+
402  void negate (const Box& region,
+
403  int comp,
+
404  int num_comp,
+
405  int nghost = 0);
+
411  void negate (int nghost = 0);
+
418  void negate (const Box& region,
+
419  int nghost = 0);
+
420 
+
421  [[nodiscard]] IntVect minIndex (int comp,
+
422  int nghost = 0) const;
+
423 
+
424  [[nodiscard]] IntVect maxIndex (int comp,
+
425  int nghost = 0) const;
+
435  void plus (const MultiFab& mf,
+
436  int strt_comp,
+
437  int num_comp,
+
438  int nghost);
+
448  void minus (const MultiFab& mf,
+
449  int strt_comp,
+
450  int num_comp,
+
451  int nghost);
+
462  void divide (const MultiFab& mf,
+
463  int strt_comp,
+
464  int num_comp,
+
465  int nghost);
+
469  static Real Dot (const MultiFab& x, int xcomp,
470  const MultiFab& y, int ycomp,
471  int numcomp, int nghost, bool local = false);
-
476  static void Add (MultiFab& dst,
-
477  const MultiFab& src,
-
478  int srccomp,
-
479  int dstcomp,
-
480  int numcomp,
-
481  int nghost);
-
482 
-
483  static void Add (MultiFab& dst,
-
484  const MultiFab& src,
-
485  int srccomp,
-
486  int dstcomp,
-
487  int numcomp,
-
488  const IntVect& nghost);
-
489 
-
495  [[nodiscard]] MultiFab deepCopy () const;
-
496 
-
502  static void Copy (MultiFab& dst,
-
503  const MultiFab& src,
-
504  int srccomp,
-
505  int dstcomp,
-
506  int numcomp,
-
507  int nghost);
-
508 
-
509  static void Copy (MultiFab& dst,
-
510  const MultiFab& src,
-
511  int srccomp,
-
512  int dstcomp,
-
513  int numcomp,
-
514  const IntVect& nghost);
-
515 
-
521  static void Swap (MultiFab& dst,
-
522  MultiFab& src,
-
523  int srccomp,
-
524  int dstcomp,
-
525  int numcomp,
-
526  int nghost);
-
527 
-
528  static void Swap (MultiFab& dst,
-
529  MultiFab& src,
-
530  int srccomp,
-
531  int dstcomp,
-
532  int numcomp,
-
533  const IntVect& nghost);
-
534 
-
539  static void Subtract (MultiFab& dst,
-
540  const MultiFab& src,
-
541  int srccomp,
-
542  int dstcomp,
-
543  int numcomp,
-
544  int nghost);
+
472 
+
476  static Real Dot (const MultiFab& x, int xcomp,
+
477  int numcomp, int nghost, bool local = false);
+
478 
+
479  static Real Dot (const iMultiFab& mask,
+
480  const MultiFab& x, int xcomp,
+
481  const MultiFab& y, int ycomp,
+
482  int numcomp, int nghost, bool local = false);
+
487  static void Add (MultiFab& dst,
+
488  const MultiFab& src,
+
489  int srccomp,
+
490  int dstcomp,
+
491  int numcomp,
+
492  int nghost);
+
493 
+
494  static void Add (MultiFab& dst,
+
495  const MultiFab& src,
+
496  int srccomp,
+
497  int dstcomp,
+
498  int numcomp,
+
499  const IntVect& nghost);
+
500 
+
506  [[nodiscard]] MultiFab deepCopy () const;
+
507 
+
513  static void Copy (MultiFab& dst,
+
514  const MultiFab& src,
+
515  int srccomp,
+
516  int dstcomp,
+
517  int numcomp,
+
518  int nghost);
+
519 
+
520  static void Copy (MultiFab& dst,
+
521  const MultiFab& src,
+
522  int srccomp,
+
523  int dstcomp,
+
524  int numcomp,
+
525  const IntVect& nghost);
+
526 
+
532  static void Swap (MultiFab& dst,
+
533  MultiFab& src,
+
534  int srccomp,
+
535  int dstcomp,
+
536  int numcomp,
+
537  int nghost);
+
538 
+
539  static void Swap (MultiFab& dst,
+
540  MultiFab& src,
+
541  int srccomp,
+
542  int dstcomp,
+
543  int numcomp,
+
544  const IntVect& nghost);
545 
-
546  static void Subtract (MultiFab& dst,
-
547  const MultiFab& src,
-
548  int srccomp,
-
549  int dstcomp,
-
550  int numcomp,
-
551  const IntVect& nghost);
-
556  static void Multiply (MultiFab& dst,
-
557  const MultiFab& src,
-
558  int srccomp,
-
559  int dstcomp,
-
560  int numcomp,
-
561  int nghost);
-
562 
-
563  static void Multiply (MultiFab& dst,
-
564  const MultiFab& src,
-
565  int srccomp,
-
566  int dstcomp,
-
567  int numcomp,
-
568  const IntVect& nghost);
-
573  static void Divide (MultiFab& dst,
-
574  const MultiFab& src,
-
575  int srccomp,
-
576  int dstcomp,
-
577  int numcomp,
-
578  int nghost);
-
579 
-
580  static void Divide (MultiFab& dst,
-
581  const MultiFab& src,
-
582  int srccomp,
-
583  int dstcomp,
-
584  int numcomp,
-
585  const IntVect& nghost);
-
589  static void Saxpy (MultiFab& dst,
-
590  Real a,
-
591  const MultiFab& src,
-
592  int srccomp,
-
593  int dstcomp,
-
594  int numcomp,
-
595  int nghost);
-
596 
-
597  using FabArray<FArrayBox>::Saxpy;
-
598 
-
602  static void Xpay (MultiFab& dst,
-
603  Real a,
-
604  const MultiFab& src,
-
605  int srccomp,
-
606  int dstcomp,
-
607  int numcomp,
-
608  int nghost);
+
550  static void Subtract (MultiFab& dst,
+
551  const MultiFab& src,
+
552  int srccomp,
+
553  int dstcomp,
+
554  int numcomp,
+
555  int nghost);
+
556 
+
557  static void Subtract (MultiFab& dst,
+
558  const MultiFab& src,
+
559  int srccomp,
+
560  int dstcomp,
+
561  int numcomp,
+
562  const IntVect& nghost);
+
567  static void Multiply (MultiFab& dst,
+
568  const MultiFab& src,
+
569  int srccomp,
+
570  int dstcomp,
+
571  int numcomp,
+
572  int nghost);
+
573 
+
574  static void Multiply (MultiFab& dst,
+
575  const MultiFab& src,
+
576  int srccomp,
+
577  int dstcomp,
+
578  int numcomp,
+
579  const IntVect& nghost);
+
584  static void Divide (MultiFab& dst,
+
585  const MultiFab& src,
+
586  int srccomp,
+
587  int dstcomp,
+
588  int numcomp,
+
589  int nghost);
+
590 
+
591  static void Divide (MultiFab& dst,
+
592  const MultiFab& src,
+
593  int srccomp,
+
594  int dstcomp,
+
595  int numcomp,
+
596  const IntVect& nghost);
+
600  static void Saxpy (MultiFab& dst,
+
601  Real a,
+
602  const MultiFab& src,
+
603  int srccomp,
+
604  int dstcomp,
+
605  int numcomp,
+
606  int nghost);
+
607 
+
608  using FabArray<FArrayBox>::Saxpy;
609 
-
610  using FabArray<FArrayBox>::Xpay;
-
611 
-
615  static void LinComb (MultiFab& dst,
-
616  Real a,
-
617  const MultiFab& x,
-
618  int xcomp,
-
619  Real b,
-
620  const MultiFab& y,
-
621  int ycomp,
-
622  int dstcomp,
-
623  int numcomp,
-
624  int nghost);
-
625 
-
626  using FabArray<FArrayBox>::LinComb;
-
627 
-
631  static void AddProduct (MultiFab& dst,
-
632  const MultiFab& src1,
-
633  int comp1,
-
634  const MultiFab& src2,
-
635  int comp2,
-
636  int dstcomp,
-
637  int numcomp,
-
638  int nghost);
-
639 
-
640  static void AddProduct (MultiFab& dst,
-
641  const MultiFab& src1,
-
642  int comp1,
-
643  const MultiFab& src2,
-
644  int comp2,
-
645  int dstcomp,
-
646  int numcomp,
-
647  const IntVect& nghost);
-
648 
-
656  [[nodiscard]] bool contains_nan (bool local=false) const;
-
657  [[nodiscard]] bool contains_nan (int scomp, int ncomp, int ngrow = 0, bool local=false) const;
-
658  [[nodiscard]] bool contains_nan (int scomp, int ncomp, const IntVect& ngrow, bool local=false) const;
-
665  [[nodiscard]] bool contains_inf (bool local=false) const;
-
666  [[nodiscard]] bool contains_inf (int scomp, int ncomp, int ngrow = 0, bool local=false) const;
-
667  [[nodiscard]] bool contains_inf (int scomp, int ncomp, const IntVect& ngrow, bool local=false) const;
-
668 
-
672  [[nodiscard]] std::unique_ptr<MultiFab> OverlapMask (const Periodicity& period = Periodicity::NonPeriodic()) const;
-
674  [[nodiscard]] std::unique_ptr<iMultiFab> OwnerMask (const Periodicity& period = Periodicity::NonPeriodic()) const;
-
675 
-
677  void AverageSync (const Periodicity& period = Periodicity::NonPeriodic());
-
679  void WeightedSync (const MultiFab& wgt, const Periodicity& period = Periodicity::NonPeriodic());
-
681  void OverrideSync (const iMultiFab& msk, const Periodicity& period = Periodicity::NonPeriodic());
-
682 
-
683  using FabArray<FArrayBox>::OverrideSync;
-
684 
-
685  static void Initialize ();
-
686  static void Finalize ();
-
687 
-
688 private:
-
689  //
-
691  using CopyComTagsContainer = FabArrayBase::CopyComTagsContainer;
-
692  using MapOfCopyComTagContainers = FabArrayBase::MapOfCopyComTagContainers;
+
613  static void Xpay (MultiFab& dst,
+
614  Real a,
+
615  const MultiFab& src,
+
616  int srccomp,
+
617  int dstcomp,
+
618  int numcomp,
+
619  int nghost);
+
620 
+
621  using FabArray<FArrayBox>::Xpay;
+
622 
+
626  static void LinComb (MultiFab& dst,
+
627  Real a,
+
628  const MultiFab& x,
+
629  int xcomp,
+
630  Real b,
+
631  const MultiFab& y,
+
632  int ycomp,
+
633  int dstcomp,
+
634  int numcomp,
+
635  int nghost);
+
636 
+
637  using FabArray<FArrayBox>::LinComb;
+
638 
+
642  static void AddProduct (MultiFab& dst,
+
643  const MultiFab& src1,
+
644  int comp1,
+
645  const MultiFab& src2,
+
646  int comp2,
+
647  int dstcomp,
+
648  int numcomp,
+
649  int nghost);
+
650 
+
651  static void AddProduct (MultiFab& dst,
+
652  const MultiFab& src1,
+
653  int comp1,
+
654  const MultiFab& src2,
+
655  int comp2,
+
656  int dstcomp,
+
657  int numcomp,
+
658  const IntVect& nghost);
+
659 
+
667  [[nodiscard]] bool contains_nan (bool local=false) const;
+
668  [[nodiscard]] bool contains_nan (int scomp, int ncomp, int ngrow = 0, bool local=false) const;
+
669  [[nodiscard]] bool contains_nan (int scomp, int ncomp, const IntVect& ngrow, bool local=false) const;
+
676  [[nodiscard]] bool contains_inf (bool local=false) const;
+
677  [[nodiscard]] bool contains_inf (int scomp, int ncomp, int ngrow = 0, bool local=false) const;
+
678  [[nodiscard]] bool contains_inf (int scomp, int ncomp, const IntVect& ngrow, bool local=false) const;
+
679 
+
683  [[nodiscard]] std::unique_ptr<MultiFab> OverlapMask (const Periodicity& period = Periodicity::NonPeriodic()) const;
+
685  [[nodiscard]] std::unique_ptr<iMultiFab> OwnerMask (const Periodicity& period = Periodicity::NonPeriodic()) const;
+
686 
+
688  void AverageSync (const Periodicity& period = Periodicity::NonPeriodic());
+
690  void WeightedSync (const MultiFab& wgt, const Periodicity& period = Periodicity::NonPeriodic());
+
692  void OverrideSync (const iMultiFab& msk, const Periodicity& period = Periodicity::NonPeriodic());
693 
-
694  void initVal ();
-
695 };
-
696 
-
697 #ifndef _MSC_VER
-
698 inline void GccPlacaterMF ()
-
699 {
-
700  std::allocator<MultiFab*> a1;
-
701  std::allocator<MultiFab const*> a2;
-
702  std::allocator<FabArray<FArrayBox>*> a3;
-
703  std::allocator<FabArray<FArrayBox> const*> a4;
+
694  using FabArray<FArrayBox>::OverrideSync;
+
695 
+
696  static void Initialize ();
+
697  static void Finalize ();
+
698 
+
699 private:
+
700  //
+
702  using CopyComTagsContainer = FabArrayBase::CopyComTagsContainer;
+
703  using MapOfCopyComTagContainers = FabArrayBase::MapOfCopyComTagContainers;
704 
-
705  amrex::ignore_unused(a1);
-
706  amrex::ignore_unused(a2);
-
707  amrex::ignore_unused(a3);
-
708  amrex::ignore_unused(a4);
-
709 }
-
710 #endif
-
711 
-
712 }
-
713 
-
714 #endif /*BL_MULTIFAB_H*/
+
705  void initVal ();
+
706 };
+
707 
+
708 #ifndef _MSC_VER
+
709 inline void GccPlacaterMF ()
+
710 {
+
711  std::allocator<MultiFab*> a1;
+
712  std::allocator<MultiFab const*> a2;
+
713  std::allocator<FabArray<FArrayBox>*> a3;
+
714  std::allocator<FabArray<FArrayBox> const*> a4;
+
715 
+
716  amrex::ignore_unused(a1);
+
717  amrex::ignore_unused(a2);
+
718  amrex::ignore_unused(a3);
+
719  amrex::ignore_unused(a4);
+
720 }
+
721 #endif
+
722 
+
723 }
+
724 
+
725 #endif /*BL_MULTIFAB_H*/
AMReX_BLassert.H
AMReX_BaseFab.H
AMReX_FArrayBox.H
@@ -518,11 +520,11 @@
amrex::MultiFab
A collection (stored as an array) of FArrayBox objects.
Definition: AMReX_MultiFab.H:38
amrex::MultiFab::LinComb
static void LinComb(MultiFab &dst, Real a, const MultiFab &x, int xcomp, Real b, const MultiFab &y, int ycomp, int dstcomp, int numcomp, int nghost)
dst = a*x + b*y
Definition: AMReX_MultiFab.cpp:359
amrex::MultiFab::define
void define(const BoxArray &bxs, const DistributionMapping &dm, int nvar, int ngrow, const MFInfo &info=MFInfo(), const FabFactory< FArrayBox > &factory=FArrayBoxFactory())
Definition: AMReX_MultiFab.cpp:572
-
amrex::MultiFab::invert
void invert(Real numerator, int comp, int num_comp, int nghost=0)
Replaces the value of each cell in the specified subregion of the MultiFab with its reciprocal multip...
Definition: AMReX_MultiFab.cpp:1325
-
amrex::MultiFab::minus
void minus(const MultiFab &mf, int strt_comp, int num_comp, int nghost)
This function subtracts the values of the cells in mf from the corresponding cells of this MultiFab....
Definition: AMReX_MultiFab.cpp:1266
+
amrex::MultiFab::invert
void invert(Real numerator, int comp, int num_comp, int nghost=0)
Replaces the value of each cell in the specified subregion of the MultiFab with its reciprocal multip...
Definition: AMReX_MultiFab.cpp:1421
+
amrex::MultiFab::minus
void minus(const MultiFab &mf, int strt_comp, int num_comp, int nghost)
This function subtracts the values of the cells in mf from the corresponding cells of this MultiFab....
Definition: AMReX_MultiFab.cpp:1362
amrex::MultiFab::norm0
Real norm0(int comp=0, int nghost=0, bool local=false, bool ignore_covered=false) const
Returns the maximum absolute value contained in component comp of the MultiFab.
Definition: AMReX_MultiFab.cpp:1029
amrex::MultiFab::Swap
static void Swap(MultiFab &dst, MultiFab &src, int srccomp, int dstcomp, int numcomp, int nghost)
Swap from src to dst including nghost ghost cells. The two MultiFabs MUST have the same underlying Bo...
Definition: AMReX_MultiFab.cpp:213
-
amrex::MultiFab::OwnerMask
std::unique_ptr< iMultiFab > OwnerMask(const Periodicity &period=Periodicity::NonPeriodic()) const
Owner is the grid with the lowest grid number containing the data.
Definition: AMReX_MultiFab.cpp:1429
+
amrex::MultiFab::OwnerMask
std::unique_ptr< iMultiFab > OwnerMask(const Periodicity &period=Periodicity::NonPeriodic()) const
Owner is the grid with the lowest grid number containing the data.
Definition: AMReX_MultiFab.cpp:1525
amrex::MultiFab::Add
static void Add(MultiFab &dst, const MultiFab &src, int srccomp, int dstcomp, int numcomp, int nghost)
Add src to dst including nghost ghost cells. The two MultiFabs MUST have the same underlying BoxArray...
Definition: AMReX_MultiFab.cpp:151
amrex::MultiFab::contains_nan
bool contains_nan(bool local=false) const
Are there any NaNs in the MF? This may return false, even if the MF contains NaNs,...
Definition: AMReX_MultiFab.cpp:658
amrex::MultiFab::Saxpy
static void Saxpy(MultiFab &dst, Real a, const MultiFab &src, int srccomp, int dstcomp, int numcomp, int nghost)
dst += a*src
Definition: AMReX_MultiFab.cpp:345
@@ -535,7 +537,7 @@
amrex::MultiFab::maxIndex
IntVect maxIndex(int comp, int nghost=0) const
Definition: AMReX_MultiFab.cpp:1015
amrex::MultiFab::AddProduct
static void AddProduct(MultiFab &dst, const MultiFab &src1, int comp1, const MultiFab &src2, int comp2, int dstcomp, int numcomp, int nghost)
dst += src1*src2
Definition: AMReX_MultiFab.cpp:368
amrex::MultiFab::Initialize
static void Initialize()
Definition: AMReX_MultiFab.cpp:475
-
amrex::MultiFab::AverageSync
void AverageSync(const Periodicity &period=Periodicity::NonPeriodic())
Sync up nodal data via averaging.
Definition: AMReX_MultiFab.cpp:1435
+
amrex::MultiFab::AverageSync
void AverageSync(const Periodicity &period=Periodicity::NonPeriodic())
Sync up nodal data via averaging.
Definition: AMReX_MultiFab.cpp:1531
amrex::MultiFab::norminf
Vector< Real > norminf(const Vector< int > &comps, int nghost=0, bool local=false, bool ignore_covered=false) const
Definition: AMReX_MultiFab.H:202
amrex::MultiFab::contains_inf
bool contains_inf(bool local=false) const
Are there any Infs in the MF? This may return false, even if the MF contains Infs,...
Definition: AMReX_MultiFab.cpp:713
amrex::MultiFab::norminf
Real norminf(int comp=0, int nghost=0, bool local=false, bool ignore_covered=false) const
Definition: AMReX_MultiFab.H:183
@@ -544,23 +546,23 @@
amrex::MultiFab::operator=
MultiFab & operator=(MultiFab &&rhs) noexcept=default
amrex::MultiFab::initVal
void initVal()
Definition: AMReX_MultiFab.cpp:596
amrex::MultiFab::Divide
static void Divide(MultiFab &dst, const MultiFab &src, int srccomp, int dstcomp, int numcomp, int nghost)
Divide dst by src including nghost ghost cells. The two MultiFabs MUST have the same underlying BoxAr...
Definition: AMReX_MultiFab.cpp:325
-
amrex::MultiFab::mult
void mult(Real val, int comp, int num_comp, int nghost=0)
Scales the value of each cell in the specified subregion of the MultiFab by the scalar val (a[i] <- a...
Definition: AMReX_MultiFab.cpp:1305
-
amrex::MultiFab::plus
void plus(Real val, int comp, int num_comp, int nghost=0)
Adds the scalar value val to the value of each cell in the specified subregion of the MultiFab.
Definition: AMReX_MultiFab.cpp:1278
+
amrex::MultiFab::mult
void mult(Real val, int comp, int num_comp, int nghost=0)
Scales the value of each cell in the specified subregion of the MultiFab by the scalar val (a[i] <- a...
Definition: AMReX_MultiFab.cpp:1401
+
amrex::MultiFab::plus
void plus(Real val, int comp, int num_comp, int nghost=0)
Adds the scalar value val to the value of each cell in the specified subregion of the MultiFab.
Definition: AMReX_MultiFab.cpp:1374
amrex::MultiFab::minIndex
IntVect minIndex(int comp, int nghost=0) const
Definition: AMReX_MultiFab.cpp:1007
amrex::MultiFab::Copy
static void Copy(MultiFab &dst, const MultiFab &src, int srccomp, int dstcomp, int numcomp, int nghost)
Copy from src to dst including nghost ghost cells. The two MultiFabs MUST have the same underlying Bo...
Definition: AMReX_MultiFab.cpp:193
amrex::MultiFab::max
Real max(int comp, int nghost=0, bool local=false) const
Returns the maximum value contained in component comp of the MultiFab.
Definition: AMReX_MultiFab.cpp:848
amrex::MultiFab::norminf
Real norminf(const iMultiFab &mask, int comp=0, int nghost=0, bool local=false) const
Definition: AMReX_MultiFab.H:188
amrex::MultiFab::MultiFab
MultiFab() noexcept
Constructs an empty MultiFab.
Definition: AMReX_MultiFab.cpp:496
-
amrex::MultiFab::divide
void divide(const MultiFab &mf, int strt_comp, int num_comp, int nghost)
This function divides the values of the cells in mf from the corresponding cells of this MultiFab....
Definition: AMReX_MultiFab.cpp:1272
-
amrex::MultiFab::negate
void negate(int comp, int num_comp, int nghost=0)
Negates the value of each cell in the specified subregion of the MultiFab. The subregion consists of ...
Definition: AMReX_MultiFab.cpp:1345
+
amrex::MultiFab::divide
void divide(const MultiFab &mf, int strt_comp, int num_comp, int nghost)
This function divides the values of the cells in mf from the corresponding cells of this MultiFab....
Definition: AMReX_MultiFab.cpp:1368
+
amrex::MultiFab::negate
void negate(int comp, int num_comp, int nghost=0)
Negates the value of each cell in the specified subregion of the MultiFab. The subregion consists of ...
Definition: AMReX_MultiFab.cpp:1441
amrex::MultiFab::deepCopy
MultiFab deepCopy() const
Definition: AMReX_MultiFab.cpp:171
-
amrex::MultiFab::WeightedSync
void WeightedSync(const MultiFab &wgt, const Periodicity &period=Periodicity::NonPeriodic())
Sync up nodal data with weights.
Definition: AMReX_MultiFab.cpp:1446
+
amrex::MultiFab::WeightedSync
void WeightedSync(const MultiFab &wgt, const Periodicity &period=Periodicity::NonPeriodic())
Sync up nodal data with weights.
Definition: AMReX_MultiFab.cpp:1542
amrex::MultiFab::MultiFab
MultiFab(const MultiFab &rhs)=delete
amrex::MultiFab::~MultiFab
~MultiFab()
Definition: AMReX_MultiFab.cpp:557
amrex::MultiFab::Finalize
static void Finalize()
Definition: AMReX_MultiFab.cpp:491
-
amrex::MultiFab::OverlapMask
std::unique_ptr< MultiFab > OverlapMask(const Periodicity &period=Periodicity::NonPeriodic()) const
Return a mask indicating how many duplicates are in each point.
Definition: AMReX_MultiFab.cpp:1363
-
amrex::MultiFab::OverrideSync
void OverrideSync(const iMultiFab &msk, const Periodicity &period=Periodicity::NonPeriodic())
Sync up nodal data with owners overriding non-owners.
Definition: AMReX_MultiFab.cpp:1466
-
amrex::MultiFab::sum_unique
Real sum_unique(int comp=0, bool local=false, const Periodicity &period=Periodicity::NonPeriodic()) const
Same as sum with local =false, but for non-cell-centered data, this skips non-unique points that are ...
Definition: AMReX_MultiFab.cpp:1213
+
amrex::MultiFab::OverlapMask
std::unique_ptr< MultiFab > OverlapMask(const Periodicity &period=Periodicity::NonPeriodic()) const
Return a mask indicating how many duplicates are in each point.
Definition: AMReX_MultiFab.cpp:1459
+
amrex::MultiFab::OverrideSync
void OverrideSync(const iMultiFab &msk, const Periodicity &period=Periodicity::NonPeriodic())
Sync up nodal data with owners overriding non-owners.
Definition: AMReX_MultiFab.cpp:1562
+
amrex::MultiFab::sum_unique
Real sum_unique(int comp=0, bool local=false, const Periodicity &period=Periodicity::NonPeriodic()) const
Same as sum with local =false, but for non-cell-centered data, this only adds non-unique points that ...
Definition: AMReX_MultiFab.cpp:1255
amrex::Periodicity
This provides length of period for periodic domains. 0 means it is not periodic in that direction....
Definition: AMReX_Periodicity.H:17
amrex::Periodicity::NonPeriodic
static const Periodicity & NonPeriodic() noexcept
Definition: AMReX_Periodicity.cpp:49
amrex::Vector< Real >
@@ -569,7 +571,7 @@
amrex::MakeType
MakeType
Definition: AMReX_MakeType.H:7
amrex::ignore_unused
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void ignore_unused(const Ts &...)
This shuts up the compiler about unused variables.
Definition: AMReX.H:107
amrex::FArrayBoxFactory
DefaultFabFactory< FArrayBox > FArrayBoxFactory
Definition: AMReX_FArrayBox.H:494
-
amrex::GccPlacaterMF
void GccPlacaterMF()
Definition: AMReX_MultiFab.H:698
+
amrex::GccPlacaterMF
void GccPlacaterMF()
Definition: AMReX_MultiFab.H:709
amrex::MFInfo
FabArray memory allocation information.
Definition: AMReX_FabArray.H:65
diff --git a/amrex/docs_html/doxygen/AMReX__ParticleContainerI_8H_source.html b/amrex/docs_html/doxygen/AMReX__ParticleContainerI_8H_source.html index 60c311a325..f3bca6448d 100644 --- a/amrex/docs_html/doxygen/AMReX__ParticleContainerI_8H_source.html +++ b/amrex/docs_html/doxygen/AMReX__ParticleContainerI_8H_source.html @@ -2672,7 +2672,7 @@
amrex::MFIter
Definition: AMReX_MFIter.H:57
amrex::MFIter::isValid
bool isValid() const noexcept
Is the iterator valid i.e. is it associated with a FAB?
Definition: AMReX_MFIter.H:141
amrex::MultiFab
A collection (stored as an array) of FArrayBox objects.
Definition: AMReX_MultiFab.H:38
-
amrex::MultiFab::mult
void mult(Real val, int comp, int num_comp, int nghost=0)
Scales the value of each cell in the specified subregion of the MultiFab by the scalar val (a[i] <- a...
Definition: AMReX_MultiFab.cpp:1305
+
amrex::MultiFab::mult
void mult(Real val, int comp, int num_comp, int nghost=0)
Scales the value of each cell in the specified subregion of the MultiFab by the scalar val (a[i] <- a...
Definition: AMReX_MultiFab.cpp:1401
amrex::PODVector
Definition: AMReX_PODVector.H:217
amrex::PODVector::size
size_type size() const noexcept
Definition: AMReX_PODVector.H:545
amrex::PODVector::data
T * data() noexcept
Definition: AMReX_PODVector.H:563
diff --git a/amrex/docs_html/doxygen/classamrex_1_1MultiFab-members.html b/amrex/docs_html/doxygen/classamrex_1_1MultiFab-members.html index 45d20491f3..be36b80964 100644 --- a/amrex/docs_html/doxygen/classamrex_1_1MultiFab-members.html +++ b/amrex/docs_html/doxygen/classamrex_1_1MultiFab-members.html @@ -482,8 +482,10 @@ Subtract(MultiFab &dst, const MultiFab &src, int srccomp, int dstcomp, int numcomp, int nghost)amrex::MultiFabstatic Subtract(MultiFab &dst, const MultiFab &src, int srccomp, int dstcomp, int numcomp, const IntVect &nghost)amrex::MultiFabstatic sum(int comp=0, bool local=false) constamrex::MultiFab - FabArray< FArrayBox >::sum(int comp, IntVect const &nghost, bool local=false) constamrex::FabArray< FArrayBox > - sum_unique(int comp=0, bool local=false, const Periodicity &period=Periodicity::NonPeriodic()) constamrex::MultiFab + sum(Box const &region, int comp=0, bool local=false) constamrex::MultiFab + FabArray< FArrayBox >::sum(int comp, IntVect const &nghost, bool local=false) constamrex::FabArray< FArrayBox > + sum_unique(int comp=0, bool local=false, const Periodicity &period=Periodicity::NonPeriodic()) constamrex::MultiFab + sum_unique(Box const &region, int comp=0, bool local=false) constamrex::MultiFab SumBoundary(const Periodicity &period=Periodicity::NonPeriodic())amrex::FabArray< FArrayBox > SumBoundary(int scomp, int ncomp, const Periodicity &period=Periodicity::NonPeriodic())amrex::FabArray< FArrayBox > SumBoundary(int scomp, int ncomp, IntVect const &nghost, const Periodicity &period=Periodicity::NonPeriodic())amrex::FabArray< FArrayBox > diff --git a/amrex/docs_html/doxygen/classamrex_1_1MultiFab.html b/amrex/docs_html/doxygen/classamrex_1_1MultiFab.html index e8c3b42fbd..416b00c174 100644 --- a/amrex/docs_html/doxygen/classamrex_1_1MultiFab.html +++ b/amrex/docs_html/doxygen/classamrex_1_1MultiFab.html @@ -202,9 +202,15 @@ Real sum (int comp=0, bool local=false) const  Returns the sum of component "comp" over the MultiFab – no ghost cells are included. More...
  +Real sum (Box const &region, int comp=0, bool local=false) const + Returns the sum of component "comp" in the given "region". – no ghost cells are included. More...
+  Real sum_unique (int comp=0, bool local=false, const Periodicity &period=Periodicity::NonPeriodic()) const - Same as sum with local =false, but for non-cell-centered data, this skips non-unique points that are owned by multiple boxes. More...
+ Same as sum with local =false, but for non-cell-centered data, this only adds non-unique points that are owned by multiple boxes once. More...
  +Real sum_unique (Box const &region, int comp=0, bool local=false) const + Returns the unique sum of component "comp" in the given region. Non-unique points owned by multiple boxes in the MultiFab are only added once. No ghost cells are included. This function does not take periodicity into account in the determination of uniqueness of points. More...
+  void plus (Real val, int comp, int num_comp, int nghost=0)  Adds the scalar value val to the value of each cell in the specified subregion of the MultiFab. More...
  @@ -4551,10 +4557,46 @@

BoxArray.

+ + + +

◆ sum() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Real amrex::MultiFab::sum (Box const & region,
int comp = 0,
bool local = false 
) const
+
+ +

Returns the sum of component "comp" in the given "region". – no ghost cells are included.

+
-

◆ sum()

+

◆ sum() [2/2]

@@ -4581,10 +4623,46 @@

MultiFab – no ghost cells are included.

+

+
+ +

◆ sum_unique() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Real amrex::MultiFab::sum_unique (Box const & region,
int comp = 0,
bool local = false 
) const
+
+ +

Returns the unique sum of component "comp" in the given region. Non-unique points owned by multiple boxes in the MultiFab are only added once. No ghost cells are included. This function does not take periodicity into account in the determination of uniqueness of points.

+
-

◆ sum_unique()

+

◆ sum_unique() [2/2]

@@ -4615,7 +4693,7 @@

-

Same as sum with local =false, but for non-cell-centered data, this skips non-unique points that are owned by multiple boxes.

+

Same as sum with local =false, but for non-cell-centered data, this only adds non-unique points that are owned by multiple boxes once.

diff --git a/amrex/docs_html/doxygen/classamrex_1_1MultiFab.js b/amrex/docs_html/doxygen/classamrex_1_1MultiFab.js index 1a3d89485f..5358dcf563 100644 --- a/amrex/docs_html/doxygen/classamrex_1_1MultiFab.js +++ b/amrex/docs_html/doxygen/classamrex_1_1MultiFab.js @@ -84,7 +84,9 @@ var classamrex_1_1MultiFab = [ "Saxpy", "classamrex_1_1MultiFab.html#a505eb471a78f4e0f8791b10cbb1bbd75", null ], [ "Subtract", "classamrex_1_1MultiFab.html#a4f2c04ea9d0f7a551bc2263b9a63d324", null ], [ "Subtract", "classamrex_1_1MultiFab.html#a5f37af40303a10e8d54e15c1931a5b8e", null ], + [ "sum", "classamrex_1_1MultiFab.html#a623e2f01e2a7695e835d258d1a8067b7", null ], [ "sum", "classamrex_1_1MultiFab.html#a62669a27ec4a577f0bef72dc2a1243aa", null ], + [ "sum_unique", "classamrex_1_1MultiFab.html#a7c6f3136fca76d4f0f827c45420ca7ab", null ], [ "sum_unique", "classamrex_1_1MultiFab.html#afe7c47dff8cf8e0fb550d0e78c7b5375", null ], [ "Swap", "classamrex_1_1MultiFab.html#ac259813cd54d52b5c20cad7c0f24c246", null ], [ "Swap", "classamrex_1_1MultiFab.html#a2e29e28afce0aa520da5cd068cb5e96b", null ], diff --git a/amrex/docs_html/doxygen/functions_func_s.html b/amrex/docs_html/doxygen/functions_func_s.html index 46935eaf4d..33bce99eef 100644 --- a/amrex/docs_html/doxygen/functions_func_s.html +++ b/amrex/docs_html/doxygen/functions_func_s.html @@ -496,7 +496,7 @@

- s -