Program Listing for File GravityInterface.h

↰ Return to documentation for file (include/Karana/GeneralKModels/GravityInterface.h)

/*
*Copyright(c)2024-2026KaranaDynamicsPtyLtd.Allrightsreserved.
*
*NOTICETOUSER:
*
*Thissourcecodeand/ordocumentation(the"LicensedMaterials")is
*theconfidentialandproprietaryinformationofKaranaDynamicsInc.
*UseoftheseLicensedMaterialsisgovernedbythetermsandconditions
*ofaseparatesoftwarelicenseagreementbetweenKaranaDynamicsandthe
*Licensee("LicenseAgreement").Unlessexpresslypermittedunderthat
*agreement,anyreproduction,modification,distribution,ordisclosure
*oftheLicensedMaterials,inwholeorinpart,toanythirdparty
*withoutthepriorwrittenconsentofKaranaDynamicsisstrictlyprohibited.
*
*THELICENSEDMATERIALSAREPROVIDED"ASIS"WITHOUTWARRANTYOFANYKIND.
*KARANADYNAMICSDISCLAIMSALLWARRANTIES,EXPRESSORIMPLIED,INCLUDING
*BUTNOTLIMITEDTOWARRANTIESOFMERCHANTABILITY,NON-INFRINGEMENT,AND
*FITNESSFORAPARTICULARPURPOSE.
*
*INNOEVENTSHALLKARANADYNAMICSBELIABLEFORANYDAMAGESWHATSOEVER,
*INCLUDINGBUTNOTLIMITEDTOLOSSOFPROFITS,DATA,ORUSE,EVENIF
*ADVISEDOFTHEPOSSIBILITYOFSUCHDAMAGES,WHETHERINCONTRACT,TORT,
*OROTHERWISEARISINGOUTOFORINCONNECTIONWITHTHELICENSEDMATERIALS.
*
*U.S.GovernmentEndUsers:TheLicensedMaterialsarea"commercialitem"
*asdefinedat48C.F.R.2.101,andareprovidedtotheU.S.Government
*onlyasacommercialenditemunderthetermsofthislicense.
*
*AnyuseoftheLicensedMaterialsinindividualorcommercialsoftwaremust
*include,intheuserdocumentationandinternalsourcecodecomments,
*thisNotice,Disclaimer,andU.S.GovernmentUseProvision.
*/


#pragmaonce

#include"Karana/KCore/Base.h"
#include"Karana/Math/Defs.h"
#include"Karana/SOADyn/KModel.h"
#include"Karana/SOADyn/SubTree.h"

namespaceKarana::Models{

namespacekm=Karana::Math;
namespacekc=Karana::Core;
namespacekf=Karana::Frame;
namespacekd=Karana::Dynamics;
namespacekmo=Karana::Models;

structGravityOutput{
km::Vec3g;

km::Ktimet;

kmo::OutputUpdateTypeupdate_type;
};

classGravityInterface:publickc::Base{
public:
GravityInterface(std::string_viewname);

boolisReady()constoverride;

virtualvoidcomputeGravity(constkm::Ktimet,
constOutputUpdateType&output_update_type)=0;

constGravityOutput&getGravity()const;

voidsetGravity(constkm::Vec3&g,
constkm::Ktimet,
constOutputUpdateType&output_update_type);

protected:
GravityOutput_g;
};

classUniformGravity:publicGravityInterface{
public:
UniformGravity(std::string_viewname);

voidcomputeGravity(constkm::Ktimet,constOutputUpdateType&output_update_type)override;

statickc::ks_ptr<UniformGravity>create(std::string_viewname);

std::stringdumpString(std::string_viewprefix="",
constBase::DumpOptions*options=nullptr)constoverride;
};

classPointMassGravity:publicGravityInterface{
public:
PointMassGravity(std::string_viewname,
constkc::ks_ptr<kd::SubTree>&st,
constkc::ks_ptr<kf::Frame>&central_body);

voidcomputeGravity(constkm::Ktimet,constOutputUpdateType&output_update_type)override;

statickc::ks_ptr<PointMassGravity>create(std::string_viewname,
constkc::ks_ptr<kd::SubTree>&st,
constkc::ks_ptr<kf::Frame>&central_body);

doublemu=km::notReadyNaN;

boolisReady()constoverride;

std::array<kc::id_t,2>getObjIds()const;

std::stringdumpString(std::string_viewprefix="",
constBase::DumpOptions*options=nullptr)constoverride;

private:
kc::ks_ptr<kd::SubTree>_st;

constkc::ks_ptr<kf::Frame>_cb;
};

}//namespaceKarana::Models