preCICE v3.1.2
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | List of all members
precice::action::ScaleByAreaAction Class Reference

#include <ScaleByAreaAction.hpp>

Inheritance diagram for precice::action::ScaleByAreaAction:
[legend]
Collaboration diagram for precice::action::ScaleByAreaAction:
[legend]

Public Types

enum  Scaling { SCALING_DIVIDE_BY_AREA , SCALING_MULTIPLY_BY_AREA }
 
- Public Types inherited from precice::action::Action
enum  Timing { WRITE_MAPPING_POST , READ_MAPPING_POST }
 Defines the time and place of application of the action. More...
 

Public Member Functions

 ScaleByAreaAction (Timing timing, int targetDataID, const mesh::PtrMesh &mesh, Scaling scaling)
 Constructor.
 
void performAction () final override
 Scales data on mesh nodes according to selected scaling type.
 
- Public Member Functions inherited from precice::action::Action
 Action (Timing timing, const mesh::PtrMesh &mesh, mapping::Mapping::MeshRequirement requirement)
 
 Action (Timing timing, const mesh::PtrMesh &mesh)
 
Actionoperator= (Action &&)=delete
 
virtual ~Action ()=default
 Destructor, empty.
 
Timing getTiming () const
 Returns the timing of the action.
 
const mesh::PtrMeshgetMesh () const
 Returns the mesh carrying the data used in the action.
 
mapping::Mapping::MeshRequirement getMeshRequirement () const
 Returns the mesh requirement of this action.
 

Private Attributes

logging::Logger _log {"action::ScaleByAreaAction"}
 
mesh::PtrData _targetData
 
Scaling _scaling
 

Detailed Description

Definition at line 10 of file ScaleByAreaAction.hpp.

Member Enumeration Documentation

◆ Scaling

Enumerator
SCALING_DIVIDE_BY_AREA 

Divides the data by the area of neighboring edges/triangles.

SCALING_MULTIPLY_BY_AREA 

Multiplies the data by the area of neighboring edges/triangles.

Definition at line 12 of file ScaleByAreaAction.hpp.

Constructor & Destructor Documentation

◆ ScaleByAreaAction()

precice::action::ScaleByAreaAction::ScaleByAreaAction ( Timing timing,
int targetDataID,
const mesh::PtrMesh & mesh,
Scaling scaling )

Constructor.

Parameters
[in]dataData that should be scaled.
[in]scalingTypeType of scaling to be performed.

Definition at line 15 of file ScaleByAreaAction.cpp.

Member Function Documentation

◆ performAction()

void precice::action::ScaleByAreaAction::performAction ( )
finaloverridevirtual

Scales data on mesh nodes according to selected scaling type.

Implements precice::action::Action.

Definition at line 26 of file ScaleByAreaAction.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _log

logging::Logger precice::action::ScaleByAreaAction::_log {"action::ScaleByAreaAction"}
private

Definition at line 37 of file ScaleByAreaAction.hpp.

◆ _scaling

Scaling precice::action::ScaleByAreaAction::_scaling
private

Definition at line 41 of file ScaleByAreaAction.hpp.

◆ _targetData

mesh::PtrData precice::action::ScaleByAreaAction::_targetData
private

Definition at line 39 of file ScaleByAreaAction.hpp.


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