amrex::ClusterList Class Reference

A list of Cluster objects. More...

#include <AMReX_Cluster.H>

Public Member Functions
	ClusterList ()=default
	The default constructor. More...
	ClusterList (IntVect *pts, Long len)
	Construct a list containing Cluster(pts,len). More...
	~ClusterList ()
	The destructor. More...
	ClusterList (const ClusterList &)=delete
	ClusterList (ClusterList &&)=delete
ClusterList &	operator= (const ClusterList &)=delete
ClusterList &	operator= (ClusterList &&)=delete
int	length () const
	Return number of clusters in list. More...
void	append (Cluster *c)
	Add cluster to end of list. More...
BoxArray	boxArray () const
	Return array of boxes corresponding to clusters. More...
void	boxArray (BoxArray &ba) const
	Return array of boxes corresponding to clusters in argument. More...
BoxList	boxList () const
	Return list of boxes corresponding to clusters. More...
void	boxList (BoxList &blst) const
	Return list of boxes corresponding to clusters in argument. More...
void	chop (Real eff)
	Chop all clusters in list that have poor efficiency. More...
void	new_chop (Real eff)
	Chop all clusters in list that have poor efficiency. This version calls new_chop() instead of chop() More...
void	intersect (BoxArray &ba)
	Intersect clusters with BoxArray to insure cluster boxes are interior to the domain of BoxArray. Note that ba is modified during the process. More...

Private Attributes
std::list< Cluster * >	lst
	The data. More...

Detailed Description

A list of Cluster objects.

A container class for Cluster.

Constructor & Destructor Documentation

ClusterList() [1/4]

amrex::ClusterList::ClusterList ( )

default

The default constructor.

ClusterList() [2/4]

amrex::ClusterList::ClusterList	(	IntVect *	pts,
		Long	len
	)

Construct a list containing Cluster(pts,len).

Parameters

pts
len

~ClusterList()

amrex::ClusterList::~ClusterList

(

)

The destructor.

ClusterList() [3/4]

amrex::ClusterList::ClusterList ( const ClusterList &  )

delete

ClusterList() [4/4]

amrex::ClusterList::ClusterList ( ClusterList &&  )

delete

Member Function Documentation

append()

void amrex::ClusterList::append ( Cluster *  c )

inline

Add cluster to end of list.

Parameters

c

boxArray() [1/2]

BoxArray amrex::ClusterList::boxArray

(

)

const

Return array of boxes corresponding to clusters.

boxArray() [2/2]

void amrex::ClusterList::boxArray

(

BoxArray &

ba

)

const

Return array of boxes corresponding to clusters in argument.

Parameters

ba

boxList() [1/2]

BoxList amrex::ClusterList::boxList

(

)

const

Return list of boxes corresponding to clusters.

boxList() [2/2]

void amrex::ClusterList::boxList

(

BoxList &

blst

)

const

Return list of boxes corresponding to clusters in argument.

Parameters

blst

chop()

void amrex::ClusterList::chop

(

Real

eff

)

Chop all clusters in list that have poor efficiency.

Parameters

eff

intersect()

void amrex::ClusterList::intersect

(

BoxArray &

ba

)

Intersect clusters with BoxArray to insure cluster boxes are interior to the domain of BoxArray. Note that ba is modified during the process.

Parameters

ba

length()

int amrex::ClusterList::length ( ) const

inline

Return number of clusters in list.

new_chop()

void amrex::ClusterList::new_chop

(

Real

eff

)

Chop all clusters in list that have poor efficiency. This version calls new_chop() instead of chop()

Parameters

eff

operator=() [1/2]

ClusterList& amrex::ClusterList::operator= ( ClusterList &&  )

delete

operator=() [2/2]

ClusterList& amrex::ClusterList::operator= ( const ClusterList &  )

delete

Member Data Documentation

lst

std::list<Cluster*> amrex::ClusterList::lst

private

The data.

---

The documentation for this class was generated from the following files:

• /home/runner/work/amrex/amrex/Src/AmrCore/AMReX_Cluster.H
• /home/runner/work/amrex/amrex/Src/AmrCore/AMReX_Cluster.cpp