geos::multiscale::CartesianPartitioner Class Reference

Simple structured partitioner for Cartesian grids. More...

#include <CartesianPartitioner.hpp>

Inheritance diagram for geos::multiscale::CartesianPartitioner:

Public Member Functions
virtual localIndex	generate (multiscale::MeshLevel const &mesh, arrayView1d< localIndex > const &partition) override
	Generate a partitioning of fine-scale mesh cells. More...
virtual void	setCoarseData (multiscale::MeshLevel &coarseMesh) const override
	Store auxiliary partitioning-related data on the coarse mesh. More...
	PartitionerBase (LinearSolverParameters::Multiscale::Coarsening params)
	Constructor. More...
Public Member Functions inherited from geos::multiscale::PartitionerBase
	PartitionerBase (LinearSolverParameters::Multiscale::Coarsening params)
	Constructor. More...
virtual	~PartitionerBase ()=default
	Destructor.

Additional Inherited Members
Static Public Member Functions inherited from geos::multiscale::PartitionerBase
static std::unique_ptr< PartitionerBase >	create (LinearSolverParameters::Multiscale::Coarsening params)
	Factory method for instantiating a partitioner based on parameters. More...
Protected Attributes inherited from geos::multiscale::PartitionerBase
LinearSolverParameters::Multiscale::Coarsening	m_params
	Coarsening parameters.

Detailed Description

Simple structured partitioner for Cartesian grids.

Definition at line 32 of file CartesianPartitioner.hpp.

Member Function Documentation

generate()

virtual localIndex geos::multiscale::CartesianPartitioner::generate ( multiscale::MeshLevel const &  mesh, arrayView1d< localIndex > const &  partition  )

overridevirtual

Generate a partitioning of fine-scale mesh cells.

Parameters

mesh	the fine-scale mesh
partition	the partition index output array (that must be properly sized)

Returns

the number of partitions generated

Implements geos::multiscale::PartitionerBase.

PartitionerBase()

geos::multiscale::PartitionerBase::PartitionerBase

inlineexplicit

Constructor.

Parameters

params

coarsening parameters

Definition at line 51 of file PartitionerBase.hpp.

setCoarseData()

virtual void geos::multiscale::CartesianPartitioner::setCoarseData ( multiscale::MeshLevel &  coarseMesh ) const

overridevirtual

Store auxiliary partitioning-related data on the coarse mesh.

Parameters

coarseMesh

the coarse mesh

This function can be used to transfer auxiliary data used by the partitioner implementation onto the coarse grid after it's been created based on the previously generated partition. For example, a Cartesian partitioner may need to assign Cartesian indices to newly generated coarse cells, so that it can be later applied to the coarse grid recursively.

Note

It is expected that the coarse mesh contains exactly as many cells as there are unique partition indices produced by generate().

Reimplemented from geos::multiscale::PartitionerBase.

---

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

• coreComponents/linearAlgebra/multiscale/mesh/coarsening/CartesianPartitioner.hpp