walberla::pe_coupling::discrete_particle_methods::GNSExternalForceToForceFieldAdder 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. GNS speciality: the external force is additionally multiplied by the fluid volume fraction before it is added.

#include <GNSExternalForceToForceFieldAdder.h>

Public Types

using ForceField_T = GhostLayerField< Vector3< real_t >, 1 >
 
using ScalarField_T = GhostLayerField< real_t, 1 >
 

Public Member Functions

 GNSExternalForceToForceFieldAdder (const BlockDataID &forceFieldID, const ConstBlockDataID &solidVolumeFractionFieldID, const Vector3< real_t > &externalForce)
 
void operator() (IBlock *const block)
 
void reset (const Vector3< real_t > &newExternalForce)
 

Private Attributes

const BlockDataID forceFieldID_
 
const ConstBlockDataID solidVolumeFractionFieldID_
 
Vector3< real_texternalForce_
 

Member Typedef Documentation

◆ ForceField_T

◆ ScalarField_T

Constructor & Destructor Documentation

◆ GNSExternalForceToForceFieldAdder()

walberla::pe_coupling::discrete_particle_methods::GNSExternalForceToForceFieldAdder::GNSExternalForceToForceFieldAdder ( const BlockDataID forceFieldID,
const ConstBlockDataID solidVolumeFractionFieldID,
const Vector3< real_t > &  externalForce 
)
inline

Member Function Documentation

◆ operator()()

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

◆ reset()

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

Member Data Documentation

◆ externalForce_

Vector3<real_t> walberla::pe_coupling::discrete_particle_methods::GNSExternalForceToForceFieldAdder::externalForce_
private

◆ forceFieldID_

const BlockDataID walberla::pe_coupling::discrete_particle_methods::GNSExternalForceToForceFieldAdder::forceFieldID_
private

◆ solidVolumeFractionFieldID_

const ConstBlockDataID walberla::pe_coupling::discrete_particle_methods::GNSExternalForceToForceFieldAdder::solidVolumeFractionFieldID_
private

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