walberla::pe_coupling::discrete_particle_methods::ExternalForceToForceFieldAdder Class Reference

Detailed Description

Applies a given constant external force to a force field.

Utility function when using external forces with methods that couple over the force field (all discrete particle methods, e.g.) since the force field is typically reset in each iteration.

#include <ExternalForceToForceFieldAdder.h>

Public Types
using	ForceField_T = GhostLayerField< Vector3< real_t >, 1 >

Public Member Functions
	ExternalForceToForceFieldAdder (const BlockDataID &forceFieldID, const Vector3< real_t > &externalForce)
void	operator() (IBlock *const block)
void	reset (const Vector3< real_t > &newExternalForce)

Private Attributes
const BlockDataID	forceFieldID_
Vector3< real_t >	externalForce_

Member Typedef Documentation

ForceField_T

using walberla::pe_coupling::discrete_particle_methods::ExternalForceToForceFieldAdder::ForceField_T = GhostLayerField<Vector3<real_t>, 1>

Constructor & Destructor Documentation

ExternalForceToForceFieldAdder()

walberla::pe_coupling::discrete_particle_methods::ExternalForceToForceFieldAdder::ExternalForceToForceFieldAdder ( const BlockDataID &  forceFieldID, const Vector3< real_t > &  externalForce  )

inline

Member Function Documentation

operator()()

void walberla::pe_coupling::discrete_particle_methods::ExternalForceToForceFieldAdder::operator() ( IBlock *const  block )

inline

reset()

void walberla::pe_coupling::discrete_particle_methods::ExternalForceToForceFieldAdder::reset ( const Vector3< real_t > &  newExternalForce )

inline

Member Data Documentation

externalForce_

Vector3<real_t> walberla::pe_coupling::discrete_particle_methods::ExternalForceToForceFieldAdder::externalForce_

private

forceFieldID_

const BlockDataID walberla::pe_coupling::discrete_particle_methods::ExternalForceToForceFieldAdder::forceFieldID_

private

---

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

• /builds/administration/walberla-website/walberla/src/pe_coupling/discrete_particle_methods/utility/ExternalForceToForceFieldAdder.h