LifeV
FSIData Class Reference

FSIData - Data container for FSI problems. More...

#include <FSIData.hpp>

+ Collaboration diagram for FSIData:

Private Attributes

dataFluidPtr_Type M_dataFluid
 
dataSolidPtr_Type M_dataSolid
 
timePtr_Type M_timeALE
 
timeAdvancePtr_Type M_timeAdvanceALE
 
UInt M_maxSubIterationNumber
 
Real M_absoluteTolerance
 
Real M_relativeTolerance
 
Real M_errorTolerance
 
Int M_NonLinearLineSearch
 
std::string M_method
 
std::string M_algorithm
 
Real M_defaultOmega
 
std::array< Real, 2 > M_rangeOmega
 
Int M_updateEvery
 
Int M_fluidInterfaceFlag
 
Int M_structureInterfaceFlag
 
std::unique_ptr< Int const > M_fluidInterfaceVertexFlag
 
std::unique_ptr< Int const > M_structureInterfaceVertexFlag
 
Real M_interfaceTolerance
 
Real M_restartTimeStep
 

Type definitions

typedef OseenData dataFluid_Type
 
typedef std::shared_ptr< dataFluid_TypedataFluidPtr_Type
 
typedef StructuralConstitutiveLawData dataSolid_Type
 
typedef std::shared_ptr< dataSolid_TypedataSolidPtr_Type
 
typedef dataFluid_Type::time_Type time_Type
 
typedef dataFluid_Type::timePtr_Type timePtr_Type
 
typedef dataFluid_Type::timeAdvance_Type timeAdvance_Type
 
typedef dataFluid_Type::timeAdvancePtr_Type timeAdvancePtr_Type
 

Constructors & Destructor

 FSIData ()
 Empty Constructor. More...
 
 FSIData (const FSIData &FSIData)
 Copy constructor. More...
 
virtual ~FSIData ()
 Destructor. More...
 

Operators

FSIDataoperator= (const FSIData &FSIData)
 Operator=. More...
 

Methods

void setup (const GetPot &dataFile, const std::string &section="problem")
 Read the dataFile and set all the quantities. More...
 
void showMe (std::ostream &output=std::cout)
 Display the values. More...
 
bool isMonolithic ()
 

Set methods

void setDataFluid (const dataFluidPtr_Type &dataFluid)
 Set data fluid container. More...
 
void setDataSolid (const dataSolidPtr_Type &dataSolid)
 Set data solid container. More...
 
void setTimeDataALE (const timePtr_Type &timeALE)
 Set TimeData ALE container. More...
 
void setTimeAdvanceDataALE (const timeAdvancePtr_Type &timeAdvanceALE)
 Set TimeData ALE container. More...
 

Get methods

const dataFluidPtr_TypedataFluid () const
 Get data fluid container. More...
 
const dataSolidPtr_TypedataSolid () const
 Get data solid container. More...
 
const timePtr_TypetimeDataALE () const
 Get data time ALE. More...
 
const timeAdvancePtr_TypetimeAdvanceDataALE () const
 Get data time ALE. More...
 
const UIntmaxSubIterationNumber () const
 Get maximum number of subiterations. More...
 
const RealabsoluteTolerance () const
 Get absolute tolerance. More...
 
const RealrelativeTolerance () const
 Get relative tolerance. More...
 
const RealerrorTolerance () const
 Get error tolerance. More...
 
const IntNonLinearLineSearch () const
 Get NonLinearLineSearch. More...
 
const std::string & method () const
 Get method type. More...
 
const std::string & algorithm () const
 Get algorithm type. More...
 
const RealdefaultOmega () const
 Get default omega for Aitken iterations. More...
 
const std::array< Real, 2 > & OmegaRange () const
 Get the range of omega for Aitken iterations. More...
 
const IntupdateEvery () const
 Get update every. More...
 
const IntfluidInterfaceFlag () const
 Get the fluid Interface Flag. More...
 
const IntstructureInterfaceFlag () const
 Get the structure Interface Flag. More...
 
Int const * fluidInterfaceVertexFlag () const
 Get the fluid Interface Flag (for Vertices) More...
 
Int const * structureInterfaceVertexFlag () const
 Get the fluid Interface Flag (for Vertices) More...
 
const RealinterfaceTolerance () const
 Get the tolerance for the Interface identification. More...
 
Real restartTimeStep () const
 Get the timestep to restart the simulation. More...
 

Detailed Description

FSIData - Data container for FSI problems.

Author
Cristiano Malossi

Definition at line 55 of file FSIData.hpp.

Member Typedef Documentation

◆ dataFluid_Type

Definition at line 62 of file FSIData.hpp.

◆ dataFluidPtr_Type

typedef std::shared_ptr< dataFluid_Type > dataFluidPtr_Type

Definition at line 63 of file FSIData.hpp.

◆ dataSolid_Type

Definition at line 65 of file FSIData.hpp.

◆ dataSolidPtr_Type

typedef std::shared_ptr< dataSolid_Type > dataSolidPtr_Type

Definition at line 66 of file FSIData.hpp.

◆ time_Type

Definition at line 68 of file FSIData.hpp.

◆ timePtr_Type

Definition at line 69 of file FSIData.hpp.

◆ timeAdvance_Type

Definition at line 71 of file FSIData.hpp.

◆ timeAdvancePtr_Type

Constructor & Destructor Documentation

◆ FSIData() [1/2]

FSIData ( )
explicit

Empty Constructor.

Definition at line 48 of file FSIData.cpp.

◆ FSIData() [2/2]

FSIData ( const FSIData FSIData)
explicit

Copy constructor.

Parameters
FSIData- FSIData

Definition at line 69 of file FSIData.cpp.

◆ ~FSIData()

virtual ~FSIData ( )
inlinevirtual

Destructor.

Definition at line 90 of file FSIData.hpp.

Member Function Documentation

◆ operator=()

FSIData & operator= ( const FSIData FSIData)

Operator=.

Parameters
FSIData- FSIData

Definition at line 96 of file FSIData.cpp.

◆ setup()

void setup ( const GetPot dataFile,
const std::string &  section = "problem" 
)

Read the dataFile and set all the quantities.

Parameters
dataFile- data file

Definition at line 125 of file FSIData.cpp.

◆ showMe()

void showMe ( std::ostream &  output = std::cout)

Display the values.

Definition at line 188 of file FSIData.cpp.

◆ isMonolithic()

bool isMonolithic ( )

Definition at line 182 of file FSIData.cpp.

◆ setDataFluid()

void setDataFluid ( const dataFluidPtr_Type dataFluid)
inline

Set data fluid container.

Parameters
dataFluidshared_ptr to dataFluid container

Definition at line 131 of file FSIData.hpp.

◆ setDataSolid()

void setDataSolid ( const dataSolidPtr_Type dataSolid)
inline

Set data solid container.

Parameters
dataFluidshared_ptr to dataSolid container

Definition at line 140 of file FSIData.hpp.

◆ setTimeDataALE()

void setTimeDataALE ( const timePtr_Type timeALE)
inline

Set TimeData ALE container.

Parameters
timeDataALEshared_ptr to timeDataALE container

Definition at line 150 of file FSIData.hpp.

◆ setTimeAdvanceDataALE()

void setTimeAdvanceDataALE ( const timeAdvancePtr_Type timeAdvanceALE)
inline

Set TimeData ALE container.

Parameters
timeDataALEshared_ptr to timeDataALE container

Definition at line 159 of file FSIData.hpp.

◆ dataFluid()

const dataFluidPtr_Type& dataFluid ( ) const
inline

Get data fluid container.

Returns
shared_ptr to dataFluid container

Definition at line 174 of file FSIData.hpp.

◆ dataSolid()

const dataSolidPtr_Type& dataSolid ( ) const
inline

Get data solid container.

Returns
shared_ptr to dataSolid container

Definition at line 183 of file FSIData.hpp.

◆ timeDataALE()

const timePtr_Type& timeDataALE ( ) const
inline

Get data time ALE.

Returns
shared_ptr to ALE dataTime container

Definition at line 192 of file FSIData.hpp.

◆ timeAdvanceDataALE()

const timeAdvancePtr_Type& timeAdvanceDataALE ( ) const
inline

Get data time ALE.

Returns
shared_ptr to ALE dataTimeAdvance container

Definition at line 201 of file FSIData.hpp.

◆ maxSubIterationNumber()

const UInt& maxSubIterationNumber ( ) const
inline

Get maximum number of subiterations.

Returns
maximum number of subiterations

Definition at line 210 of file FSIData.hpp.

◆ absoluteTolerance()

const Real& absoluteTolerance ( ) const
inline

Get absolute tolerance.

Returns
absolute tolerance

Definition at line 219 of file FSIData.hpp.

◆ relativeTolerance()

const Real& relativeTolerance ( ) const
inline

Get relative tolerance.

Returns
relative tolerance

Definition at line 228 of file FSIData.hpp.

◆ errorTolerance()

const Real& errorTolerance ( ) const
inline

Get error tolerance.

Returns
error tolerance

Definition at line 237 of file FSIData.hpp.

◆ NonLinearLineSearch()

const Int& NonLinearLineSearch ( ) const
inline

Get NonLinearLineSearch.

Returns
NonLinearLineSearch

Definition at line 246 of file FSIData.hpp.

◆ method()

const std::string& method ( ) const
inline

Get method type.

Returns
method type

Definition at line 255 of file FSIData.hpp.

◆ algorithm()

const std::string& algorithm ( ) const
inline

Get algorithm type.

Returns
algorithm type

Definition at line 264 of file FSIData.hpp.

◆ defaultOmega()

const Real& defaultOmega ( ) const
inline

Get default omega for Aitken iterations.

Returns
default omega for Aitken iterations

Definition at line 273 of file FSIData.hpp.

◆ OmegaRange()

const std::array< Real, 2 >& OmegaRange ( ) const
inline

Get the range of omega for Aitken iterations.

Returns
range of omega for Aitken iterations

Definition at line 282 of file FSIData.hpp.

◆ updateEvery()

const Int& updateEvery ( ) const
inline

Get update every.

If M_updateEvery == 1, normal fixedPoint algorithm If M_updateEvery > 1, recompute computational domain every M_updateEvery iterations (transpiration) If M_updateEvery <= 0, recompute computational domain and matrices only at first subiteration (semi-implicit)

Returns
updateEvery value

Definition at line 295 of file FSIData.hpp.

◆ fluidInterfaceFlag()

const Int& fluidInterfaceFlag ( ) const
inline

Get the fluid Interface Flag.

Returns
Flag of the interface on the fluid boundary side

Definition at line 304 of file FSIData.hpp.

◆ structureInterfaceFlag()

const Int& structureInterfaceFlag ( ) const
inline

Get the structure Interface Flag.

Returns
Flag of the interface on the structure boundary side

Definition at line 313 of file FSIData.hpp.

◆ fluidInterfaceVertexFlag()

Int const* fluidInterfaceVertexFlag ( ) const
inline

Get the fluid Interface Flag (for Vertices)

Returns
Flag of the vertex on the interface on the fluid boundary side

Definition at line 322 of file FSIData.hpp.

◆ structureInterfaceVertexFlag()

Int const* structureInterfaceVertexFlag ( ) const
inline

Get the fluid Interface Flag (for Vertices)

Returns
Flag of the vertex on the interface on the structure boundary side

Definition at line 331 of file FSIData.hpp.

◆ interfaceTolerance()

const Real& interfaceTolerance ( ) const
inline

Get the tolerance for the Interface identification.

Returns
the tolerance for the Interface identification

Definition at line 340 of file FSIData.hpp.

◆ restartTimeStep()

Real restartTimeStep ( ) const
inline

Get the timestep to restart the simulation.

Returns
the timestep used in the previous simulation from which we want to restart, used for the initialization of the time discretization

Definition at line 350 of file FSIData.hpp.

Field Documentation

◆ M_dataFluid

dataFluidPtr_Type M_dataFluid
private

Definition at line 360 of file FSIData.hpp.

◆ M_dataSolid

dataSolidPtr_Type M_dataSolid
private

Definition at line 361 of file FSIData.hpp.

◆ M_timeALE

timePtr_Type M_timeALE
private

Definition at line 362 of file FSIData.hpp.

◆ M_timeAdvanceALE

timeAdvancePtr_Type M_timeAdvanceALE
private

Definition at line 363 of file FSIData.hpp.

◆ M_maxSubIterationNumber

UInt M_maxSubIterationNumber
private

Definition at line 366 of file FSIData.hpp.

◆ M_absoluteTolerance

Real M_absoluteTolerance
private

Definition at line 367 of file FSIData.hpp.

◆ M_relativeTolerance

Real M_relativeTolerance
private

Definition at line 368 of file FSIData.hpp.

◆ M_errorTolerance

Real M_errorTolerance
private

Definition at line 369 of file FSIData.hpp.

◆ M_NonLinearLineSearch

Int M_NonLinearLineSearch
private

Definition at line 370 of file FSIData.hpp.

◆ M_method

std::string M_method
private

Definition at line 373 of file FSIData.hpp.

◆ M_algorithm

std::string M_algorithm
private

Definition at line 374 of file FSIData.hpp.

◆ M_defaultOmega

Real M_defaultOmega
private

Definition at line 377 of file FSIData.hpp.

◆ M_rangeOmega

std::array< Real, 2 > M_rangeOmega
private

Definition at line 378 of file FSIData.hpp.

◆ M_updateEvery

Int M_updateEvery
private

Definition at line 379 of file FSIData.hpp.

◆ M_fluidInterfaceFlag

Int M_fluidInterfaceFlag
private

Definition at line 382 of file FSIData.hpp.

◆ M_structureInterfaceFlag

Int M_structureInterfaceFlag
private

Definition at line 383 of file FSIData.hpp.

◆ M_fluidInterfaceVertexFlag

std::unique_ptr<Int const> M_fluidInterfaceVertexFlag
private

Definition at line 385 of file FSIData.hpp.

◆ M_structureInterfaceVertexFlag

std::unique_ptr<Int const> M_structureInterfaceVertexFlag
private

Definition at line 386 of file FSIData.hpp.

◆ M_interfaceTolerance

Real M_interfaceTolerance
private

Definition at line 388 of file FSIData.hpp.

◆ M_restartTimeStep

Real M_restartTimeStep
private

Definition at line 390 of file FSIData.hpp.


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