Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

FluxBox Class Reference

A FArrayBox-like container for edge-centered fluxes. More...

#include <FluxBox.H>

Collaboration diagram for FluxBox:

Collaboration graph
[legend]
List of all members.

Public Methods

 FluxBox ()
 default constructor

 FluxBox (const Box &bx, int n=1)
 constructs FluxBox on cell-centered box with n components

 ~FluxBox ()
 destructor

void resize (const Box &bx, int n=1)
 resize FluxBox similar to BaseFab::resize()

void define (const Box &bx, int n=1)
void clear ()
 this function returns the FluxBox to the undefined state

int nComp () const
 {\bf access functions} number of components

const Box & box () const
 returns cell-centered box which defines fluxBox

FArrayBox & getFlux (const int dir)
 returns edge-centered flux in direction dir

const FArrayBox & getFlux (const int dir) const
FArrayBox & operator[] (const int dir)
 returns FArrayBox in direction dir

const FArrayBox & operator[] (const int dir) const
 constant version

void setVal (const Real val)
void setVal (const Real val, const int dir)
 set fluxes in direction dir to val

void setVal (const Real val, const int dir, const int startComp, const int nComp)
 more specific setVal

void setVal (const Real val, const Box &bx)
 sets fluxes on edges surrounding cell-centered box bx

void setVal (const Real val, const Box &bx, const int dir, const int startComp, const int nComp)
void copy (const FluxBox &src)
 copy from src to this FluxBox -- sizes must be identical

void copy (const FluxBox &src, const int srcComp, const int destComp, const int numComp)
 copy on overlap, for all directions

void copy (const FluxBox &src, const int dir, const int srcComp, const int destComp, const int numComp)
 copy on overlap of FluxBoxes, in direction dir

void copy (const Box &R, const Interval &Cdest, const FluxBox &src, const Interval &Csrc)
void copy (const Box &srcbox, const Interval &srccomps, const Box &destbox, const FluxBox &src, const Interval &destcomps)
FluxBox & shift (const IntVect &v)
int size (const Box &bx, const Interval &comps) const
 {\bf Linearization Functions}

void linearOut (void *buf, const Box &R, const Interval &comps) const
void linearIn (void *buf, const Box &R, const Interval &comps)

Static Public Methods

int preAllocatable ()

Protected Attributes

Box m_bx
int m_nvar
Vector< FArrayBox * > m_fluxes
 BL_SPACEDIM FArrayBoxes which hold fluxes.


Private Methods

 FluxBox (const FluxBox &)
 these are disallowed

FluxBox & operator= (const FluxBox &)

Detailed Description

A FArrayBox-like container for edge-centered fluxes.

This is a class to contain edge-centered fluxes on a box.

Constructor & Destructor Documentation

FluxBox::FluxBox (    ) 
 

default constructor

FluxBox::FluxBox (  const Box &    bx,
int    n = 1
) 
 

constructs FluxBox on cell-centered box with n components

FluxBox::~FluxBox (    ) 
 

destructor

FluxBox::FluxBox (  const FluxBox &    )  [private]
 

these are disallowed

Member Function Documentation

const Box& FluxBox::box (    )  const
 

returns cell-centered box which defines fluxBox

void FluxBox::clear (    ) 
 

this function returns the FluxBox to the undefined state

void FluxBox::copy (  const Box &    srcbox,
const Interval &    srccomps,
const Box &    destbox,
const FluxBox &    src,
const Interval &    destcomps
) 
 

void FluxBox::copy (  const Box &    R,
const Interval &    Cdest,
const FluxBox &    src,
const Interval &    Csrc
) 
 

void FluxBox::copy (  const FluxBox &    src,
const int    dir,
const int    srcComp,
const int    destComp,
const int    numComp
) 
 

copy on overlap of FluxBoxes, in direction dir

void FluxBox::copy (  const FluxBox &    src,
const int    srcComp,
const int    destComp,
const int    numComp
) 
 

copy on overlap, for all directions

void FluxBox::copy (  const FluxBox &    src ) 
 

copy from src to this FluxBox -- sizes must be identical

void FluxBox::define (  const Box &    bx,
int    n = 1
) 
 

const FArrayBox& FluxBox::getFlux (  const int    dir )  const
 

FArrayBox& FluxBox::getFlux (  const int    dir ) 
 

returns edge-centered flux in direction dir

void FluxBox::linearIn (  void *    buf,
const Box &    R,
const Interval &    comps
) 
 

void FluxBox::linearOut (  void *    buf,
const Box &    R,
const Interval &    comps
)  const
 

int FluxBox::nComp (    )  const
 

{\bf access functions} number of components

FluxBox& FluxBox::operator= (  const FluxBox &    )  [private]
 

const FArrayBox& FluxBox::operator[] (  const int    dir )  const
 

constant version

FArrayBox& FluxBox::operator[] (  const int    dir ) 
 

returns FArrayBox in direction dir

int FluxBox::preAllocatable (    )  [inline, static]
 

void FluxBox::resize (  const Box &    bx,
int    n = 1
) 
 

resize FluxBox similar to BaseFab::resize()

void FluxBox::setVal (  const Real    val,
const Box &    bx,
const int    dir,
const int    startComp,
const int    nComp
) 
 

void FluxBox::setVal (  const Real    val,
const Box &    bx
) 
 

sets fluxes on edges surrounding cell-centered box bx

void FluxBox::setVal (  const Real    val,
const int    dir,
const int    startComp,
const int    nComp
) 
 

more specific setVal

void FluxBox::setVal (  const Real    val,
const int    dir
) 
 

set fluxes in direction dir to val

void FluxBox::setVal (  const Real    val ) 
 

{\bf data modification functions} set all fluxes to val

FluxBox& FluxBox::shift (  const IntVect &    v ) 
 

Modifies the domain of this FluxBox by shifting.

int FluxBox::size (  const Box &    bx,
const Interval &    comps
)  const
 

{\bf Linearization Functions}

Member Data Documentation

Box FluxBox::m_bx [protected]
 

Vector<FArrayBox*> FluxBox::m_fluxes [protected]
 

BL_SPACEDIM FArrayBoxes which hold fluxes.

int FluxBox::m_nvar [protected]
 

The documentation for this class was generated from the following file:
Generated on Wed Apr 16 14:35:17 2003 for EBChombo by doxygen1.2.16