ABLATE Source Documentation  0.12.34
ablate::particles::processes::ArbitraryEulerianSource Class Reference
+ Inheritance diagram for ablate::particles::processes::ArbitraryEulerianSource:

Public Member Functions

 ArbitraryEulerianSource (std::string coupledFieldName, std::shared_ptr< mathFunctions::MathFunction > sourceFunction)
 
void ComputeRHS (PetscReal time, accessors::SwarmAccessor &swarmAccessor, accessors::RhsAccessor &rhsAccessor, accessors::EulerianAccessor &eulerianAccessor) override
 
void ComputeEulerianSource (PetscReal startTime, PetscReal endTime, accessors::SwarmAccessor &swarmAccessorPreStep, accessors::SwarmAccessor &swarmAccessorPostStep, accessors::EulerianSourceAccessor &eulerianSourceAccessor) override
 

Constructor & Destructor Documentation

◆ ArbitraryEulerianSource()

ablate::particles::processes::ArbitraryEulerianSource::ArbitraryEulerianSource ( std::string  coupledFieldName,
std::shared_ptr< mathFunctions::MathFunction sourceFunction 
)

Adds an arbitrary source function for each particle to the eulerian field

Parameters
coupledFieldNamethe name of the eulerian coupled field
sourceFunctionthe function to compute the source

Member Function Documentation

◆ ComputeEulerianSource()

void ablate::particles::processes::ArbitraryEulerianSource::ComputeEulerianSource ( PetscReal  startTime,
PetscReal  endTime,
accessors::SwarmAccessor swarmAccessorPreStep,
accessors::SwarmAccessor swarmAccessorPostStep,
accessors::EulerianSourceAccessor eulerianSourceAccessor 
)
overridevirtual

Add the arbitrary source to the eulerianSourceAccessor

Parameters
startTime
endTime
swarmAccessorPreStep
swarmAccessorPostStep
eulerianSourceAccessor

Implements ablate::particles::processes::CoupledProcess.

◆ ComputeRHS()

void ablate::particles::processes::ArbitraryEulerianSource::ComputeRHS ( PetscReal  time,
accessors::SwarmAccessor swarmAccessor,
accessors::RhsAccessor rhsAccessor,
accessors::EulerianAccessor eulerianAccessor 
)
inlineoverridevirtual

There is no RHS function for the ArbitraryEulerianSource

Implements ablate::particles::processes::Process.


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