ablate::particles::accessors::SwarmAccessor Class Reference

#include <swarmAccessor.hpp>

Inheritance diagram for ablate::particles::accessors::SwarmAccessor:

Public Member Functions
	SwarmAccessor (bool cachePointData, const DM &swarmDm, const std::map< std::string, Field > &fieldsMap, Vec solutionVec)
PetscInt	GetNumberParticles () const
	SwarmAccessor (const SwarmAccessor &)=delete
Public Member Functions inherited from ablate::particles::accessors::Accessor< const PetscReal >
	Accessor (bool cachePointData)
	Accessor (const Accessor &)=delete
Data< const PetscReal >	operator[] (const std::string &fieldName)
Data< const PetscReal >	GetData (const std::string &fieldName)
void	RegisterCleanupFunction (const std::function< void()> &function)

Protected Member Functions
ConstPointData	CreateData (const std::string &fieldName) override

Detailed Description

class that will be passed to each processes to allow getting required data

Constructor & Destructor Documentation

SwarmAccessor()

ablate::particles::accessors::SwarmAccessor::SwarmAccessor ( const SwarmAccessor &  )

delete

prevent copy of this class

Member Function Documentation

CreateData()

ConstPointData ablate::particles::accessors::SwarmAccessor::CreateData ( const std::string &  fieldName )

inlineoverrideprotectedvirtual

Create point data from the solution field or swarmdm

Parameters

fieldName

Returns

Implements ablate::particles::accessors::Accessor< const PetscReal >.

GetNumberParticles()

PetscInt ablate::particles::accessors::SwarmAccessor::GetNumberParticles ( ) const

inline

Returns the local size of the particles destination

Returns

---

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

• src/particles/accessors/swarmAccessor.hpp