ParticleProjector.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  ' \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
//
// This software is copyright (C) by the Lawrence Berkeley
// National Laboratory.  Permission is granted to reproduce
// this software for non-commercial purposes provided that
// this notice is left intact.
//
// It is acknowledged that the U.S. Government has rights to
// this software under Contract DE-AC03-765F00098 between
// the U.S.  Department of Energy and the University of
// California.
//
// This software is provided as a professional and academic
// contribution for joint exchange. Thus it is experimental,
// is provided ``as is'', with no warranties of any kind
// whatsoever, no support, no promise of updates, or printed
// documentation. By using this software, you acknowledge
// that the Lawrence Berkeley National Laboratory and
// Regents of the University of California shall have no
// liability with respect to the infringement of other
// copyrights by any part of this software.
//

#ifndef _PARTICLEPROJECTOR_H_
#define _PARTICLEPROJECTOR_H_



#include "DisjointBoxLayout.H"
#include "LevelData.H"
#include "BinFab.H"
#include "DragParticle.H"

class ParticleProjector
{

public:
  ParticleProjector();


  ParticleProjector(const DisjointBoxLayout& a_grids,
                    const DisjointBoxLayout& a_crseGrids,
                    const ProblemDomain& a_domain,
                    int a_nRefCrse, Real a_dx);

  ~ParticleProjector();

  void define(const DisjointBoxLayout& a_grids,
              const DisjointBoxLayout& a_crseGrids,
              const ProblemDomain& a_domain,
              int a_nRefCrse, Real a_dx);


  void projectForce(LevelData<FArrayBox>& a_force,
                    const LevelData<BinFab<DragParticle> >& a_particles);
  

  void setSpreadingRadius(const Real a_rad);

  void setCorrectionRadius(const Real a_rad);

  


  Real getSpreadingRadius() const;

  Real getCorrectionRadius() const;

  void doImages(bool m_doImages);

  bool doImages() const;

  bool isDefined() const;

  void setVerbosity(int a_verbosity);
  
  int verbosity() const;
  
protected:

  void computeD(LevelData<FArrayBox>& a_D,
                const LevelData<BinFab<DragParticle> >& a_particles);

  void solveForProjForce(LevelData<FArrayBox>& a_projectedForce,
                         const LevelData<FArrayBox>& a_D,
                         const LevelData<BinFab<DragParticle> >& a_particles);


  void addImageEffects(FArrayBox& a_rhs, 
                       int a_buffer,
                       int a_dir) const;


  void defineImages(const LevelData<BinFab<DragParticle> >& a_particles);
    
 

  DragParticle* createImageParticle(const DragParticle& a_particle,
                                    Real bndryLoc, int dir, 
                                    Side::LoHiSide a_side);

  // helper function to manage infinite domain solver interface
  void doInfiniteDomainSolve(FArrayBox& phi, 
                             const FArrayBox& rhs) const;

  void doNeumannSolve(FArrayBox& a_phi, 
                      const FArrayBox& a_rhs) const;

  void setDefaultValues();

  int infiniteDomainPadding() const;
  
  // data members

  DisjointBoxLayout m_grids;

  DisjointBoxLayout m_crseGrids;

  ProblemDomain m_domain;

  int m_nRefCrse;
  
  Real m_dx;
  
  Real m_spreadingRadius;

  Real m_correctionRadius;


  int m_s;

  int m_s1;
  int m_patchSize;

  List<DragParticle> m_imageParticles;

  bool m_doImages;

  bool m_isDefined;

  int m_verbosity;

private:

  // copy constructor illegal, etc
  ParticleProjector (const ParticleProjector& );
  ParticleProjector operator= (const ParticleProjector&);

};

#endif

---